Added config schema
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
This commit is contained in:
@@ -79,11 +79,11 @@ confluence:
|
||||
isCloud: true
|
||||
```
|
||||
|
||||
##### baseUrl
|
||||
##### Base URL
|
||||
|
||||
The `baseUrl` for Confluence Cloud should include the product name which is `wiki` by default but can be something else if your Org has changed it. An example `baseUrl` for Confluence Cloud would look like this: `https://example.atlassian.net/wiki`
|
||||
|
||||
##### token
|
||||
##### Token
|
||||
|
||||
The `token` for Confluence Cloud needs to be base-64 encoded with your Atlassian account email address. Here's how to do that:
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright 2023 The Backstage Authors
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
export interface Config {
|
||||
/** Configuration options for the Confluence to Markdown action */
|
||||
confluence?: {
|
||||
/**
|
||||
* The base URL for accessing the Confluence API
|
||||
*/
|
||||
baseUrl: string;
|
||||
/**
|
||||
* The authentication token for accessing the Confluence API
|
||||
* * @visibility secret
|
||||
*/
|
||||
token: string;
|
||||
/**
|
||||
* Flag to determine if you are on Confluence Cloud, optional
|
||||
*/
|
||||
isCloud?: string;
|
||||
};
|
||||
}
|
||||
@@ -44,6 +44,8 @@
|
||||
"msw": "^1.0.0"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
]
|
||||
"dist",
|
||||
"config.d.ts"
|
||||
],
|
||||
"configSchema": "config.d.ts"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user