Microsoft Graph GraphQL Demo
@@ -108,7 +112,9 @@
Microsoft Graph GraphQL Demo
authButton.innerHTML = 'logout';
authButton.setAttribute('onclick', 'logout();');
const label = document.getElementById('label');
- document.cookie = `accessToken=${tokenResponse.accessToken};expires=${tokenResponse.expiresOn.toUTCString()}`;
+ document.cookie = `accessToken=${
+ tokenResponse.accessToken
+ };expires=${tokenResponse.expiresOn.toUTCString()}`;
window.location.href = 'graphql/';
}
function logout() {
diff --git a/examples/odata-msgraph-programmatic-ts/src/index.ts b/examples/odata-msgraph-programmatic-ts/src/index.ts
index 144a5e8d335d6..36adbd031b0fe 100644
--- a/examples/odata-msgraph-programmatic-ts/src/index.ts
+++ b/examples/odata-msgraph-programmatic-ts/src/index.ts
@@ -6,7 +6,7 @@ async function main() {
{},
{
accessToken: 'someAccessToken',
- }
+ },
);
console.log({
result,
diff --git a/examples/odata-msgraph-programmatic/index.js b/examples/odata-msgraph-programmatic/index.js
index 1a9dbc6f2c804..1a3122b7e2766 100644
--- a/examples/odata-msgraph-programmatic/index.js
+++ b/examples/odata-msgraph-programmatic/index.js
@@ -22,7 +22,7 @@ async function main() {
{},
{
accessToken: 'someAccessToken',
- }
+ },
);
console.log({
result,
diff --git a/examples/odata-trippin/tests/odata-trippin.test.js b/examples/odata-trippin/tests/odata-trippin.test.js
index 6118257218bb8..401483e55115d 100644
--- a/examples/odata-trippin/tests/odata-trippin.test.js
+++ b/examples/odata-trippin/tests/odata-trippin.test.js
@@ -16,7 +16,7 @@ describe('OData TripPin', () => {
expect(
introspectionFromSchema(lexicographicSortSchema(schema), {
descriptions: false,
- })
+ }),
).toMatchSnapshot('odata-trippin-schema');
});
it('should give correct response for example queries', async () => {
diff --git a/examples/openapi-javascript-wiki/additional-resolvers.ts b/examples/openapi-javascript-wiki/additional-resolvers.ts
index 2f9a8d9dc5f1b..35c1a550af699 100644
--- a/examples/openapi-javascript-wiki/additional-resolvers.ts
+++ b/examples/openapi-javascript-wiki/additional-resolvers.ts
@@ -27,7 +27,7 @@ export const resolvers: Resolvers = {
}
}
`,
- }
+ },
);
if (result == null || !('items' in result)) {
diff --git a/examples/openapi-javascript-wiki/tests/javascript-wiki.test.js b/examples/openapi-javascript-wiki/tests/javascript-wiki.test.js
index efcd505cc7d1b..659ec3e8f8550 100644
--- a/examples/openapi-javascript-wiki/tests/javascript-wiki.test.js
+++ b/examples/openapi-javascript-wiki/tests/javascript-wiki.test.js
@@ -17,13 +17,13 @@ describe('JavaScript Wiki', () => {
expect(
printSchema(lexicographicSortSchema(schema), {
descriptions: false,
- })
+ }),
).toMatchSnapshot('javascript-wiki-schema');
});
it('should give correct response for viewsInPastMonth', async () => {
const viewsInPastMonthQuery = await readFile(
join(__dirname, '../example-queries/views-in-past-month.graphql'),
- 'utf8'
+ 'utf8',
);
const { execute } = await mesh$;
const result = await execute(viewsInPastMonthQuery);
@@ -33,7 +33,7 @@ describe('JavaScript Wiki', () => {
it('should give correct response for wikipediaMetrics within specific range', async () => {
const wikipediaMetricsQuery = await readFile(
join(__dirname, '../example-queries/wikipedia-metrics.graphql'),
- 'utf8'
+ 'utf8',
);
const { execute } = await mesh$;
const result = await execute(wikipediaMetricsQuery);
diff --git a/examples/openapi-location-weather/.meshrc.yaml b/examples/openapi-location-weather/.meshrc.yaml
index 67120f0032c19..da5cd2dee68e9 100644
--- a/examples/openapi-location-weather/.meshrc.yaml
+++ b/examples/openapi-location-weather/.meshrc.yaml
@@ -78,4 +78,3 @@ additionalTypeDefs: |
documents:
- ./example-query.graphql
-
diff --git a/examples/openapi-location-weather/README.md b/examples/openapi-location-weather/README.md
index a7bee0a296c69..f020d6dd7f3e3 100644
--- a/examples/openapi-location-weather/README.md
+++ b/examples/openapi-location-weather/README.md
@@ -1,4 +1,4 @@
## Location-Weather Example
-This example takes two API sources based on Openapi 3 and Swagger, and links between them.
-It allow you to query for cities / locations, and include fields for the weather of in that found place.
+This example takes two API sources based on Openapi 3 and Swagger, and links between them. It allow
+you to query for cities / locations, and include fields for the weather of in that found place.
diff --git a/examples/openapi-location-weather/tests/location-weather.test.js b/examples/openapi-location-weather/tests/location-weather.test.js
index fa26dc96f266a..44efb2292db1c 100644
--- a/examples/openapi-location-weather/tests/location-weather.test.js
+++ b/examples/openapi-location-weather/tests/location-weather.test.js
@@ -18,7 +18,7 @@ describe('Location Weather', () => {
expect(
printSchemaWithDirectives(lexicographicSortSchema(schema), {
descriptions: false,
- })
+ }),
).toMatchSnapshot('location-weather-schema');
});
it('should give correct response for todayForecast', async () => {
diff --git a/examples/openapi-react-weatherbit/src/index.css b/examples/openapi-react-weatherbit/src/index.css
index 7323ae85c542d..89e57c7ccfe1f 100644
--- a/examples/openapi-react-weatherbit/src/index.css
+++ b/examples/openapi-react-weatherbit/src/index.css
@@ -1,7 +1,7 @@
body {
margin: 0;
- font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans',
- 'Droid Sans', 'Helvetica Neue', sans-serif;
+ font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu',
+ 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
diff --git a/examples/openapi-react-weatherbit/src/index.tsx b/examples/openapi-react-weatherbit/src/index.tsx
index a662f96686be9..41e19009aa638 100644
--- a/examples/openapi-react-weatherbit/src/index.tsx
+++ b/examples/openapi-react-weatherbit/src/index.tsx
@@ -8,7 +8,7 @@ ReactDOM.render(
,
- document.getElementById('root')
+ document.getElementById('root'),
);
// If you want your app to work offline and load faster, you can change
diff --git a/examples/openapi-react-weatherbit/src/serviceWorker.ts b/examples/openapi-react-weatherbit/src/serviceWorker.ts
index acbcb4447a44c..8d74eb9db2c81 100644
--- a/examples/openapi-react-weatherbit/src/serviceWorker.ts
+++ b/examples/openapi-react-weatherbit/src/serviceWorker.ts
@@ -15,7 +15,7 @@ const isLocalhost = Boolean(
// [::1] is the IPv6 localhost address.
window.location.hostname === '[::1]' ||
// 127.0.0.0/8 are considered localhost for IPv4.
- window.location.hostname.match(/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/)
+ window.location.hostname.match(/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/),
);
type Config = {
@@ -46,7 +46,7 @@ export function register(config?: Config) {
navigator.serviceWorker.ready.then(() => {
console.log(
'This web app is being served cache-first by a service ' +
- 'worker. To learn more, visit https://bit.ly/CRA-PWA'
+ 'worker. To learn more, visit https://bit.ly/CRA-PWA',
);
});
} else {
@@ -74,7 +74,7 @@ function registerValidSW(swUrl: string, config?: Config) {
// content until all client tabs are closed.
console.log(
'New content is available and will be used when all ' +
- 'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
+ 'tabs for this page are closed. See https://bit.ly/CRA-PWA.',
);
// Execute callback
@@ -109,7 +109,10 @@ function checkValidServiceWorker(swUrl: string, config?: Config) {
.then(response => {
// Ensure service worker exists, and that we really are getting a JS file.
const contentType = response.headers.get('content-type');
- if (response.status === 404 || (contentType != null && contentType.indexOf('javascript') === -1)) {
+ if (
+ response.status === 404 ||
+ (contentType != null && contentType.indexOf('javascript') === -1)
+ ) {
// No service worker found. Probably a different app. Reload the page.
navigator.serviceWorker.ready.then(registration => {
registration.unregister().then(() => {
diff --git a/examples/openapi-stackexchange/test/openapi-stackexchange.test.ts b/examples/openapi-stackexchange/test/openapi-stackexchange.test.ts
index 0b5a6ffbe4590..f46e1ef5dfdbe 100644
--- a/examples/openapi-stackexchange/test/openapi-stackexchange.test.ts
+++ b/examples/openapi-stackexchange/test/openapi-stackexchange.test.ts
@@ -19,7 +19,10 @@ describe('Stack Exchange', () => {
expect(printSchemaWithDirectives(mesh.schema)).toMatchSnapshot();
});
it('should return the correct data', async () => {
- const listQuestionsQuery = await readFile(join(__dirname, '..', 'list-questions.query.graphql'), 'utf-8');
+ const listQuestionsQuery = await readFile(
+ join(__dirname, '..', 'list-questions.query.graphql'),
+ 'utf-8',
+ );
const result = await mesh.execute(listQuestionsQuery, {});
expect(result).toMatchObject({
data: {
diff --git a/examples/openapi-subscriptions/tests/openapi-subscriptions.test.ts b/examples/openapi-subscriptions/tests/openapi-subscriptions.test.ts
index 28fc47c187734..86bc723bbb27b 100644
--- a/examples/openapi-subscriptions/tests/openapi-subscriptions.test.ts
+++ b/examples/openapi-subscriptions/tests/openapi-subscriptions.test.ts
@@ -44,13 +44,17 @@ describe('OpenAPI Subscriptions', () => {
});
afterAll(async () => {
app.emit('destroy');
- await new Promise
((resolve, reject) => meshServer.close(err => (err ? reject(err) : resolve())));
- await new Promise((resolve, reject) => appServer.close(err => (err ? reject(err) : resolve())));
+ await new Promise((resolve, reject) =>
+ meshServer.close(err => (err ? reject(err) : resolve())),
+ );
+ await new Promise((resolve, reject) =>
+ appServer.close(err => (err ? reject(err) : resolve())),
+ );
});
it('should work', async () => {
const startWebhookMutation = await readFile(
join(__dirname, '..', 'example-queries', 'startWebhook.mutation.graphql'),
- 'utf8'
+ 'utf8',
);
const startWebhookResponse = await fetch('http://localhost:4000/graphql', {
@@ -75,7 +79,7 @@ describe('OpenAPI Subscriptions', () => {
const listenWebhookSubscription = await readFile(
join(__dirname, '..', 'example-queries', 'listenWebhook.subscription.graphql'),
- 'utf8'
+ 'utf8',
);
const listenWebhookResponse = await fetch('http://localhost:4000/graphql', {
@@ -105,7 +109,7 @@ describe('OpenAPI Subscriptions', () => {
userData: 'RANDOM_DATA',
},
},
- })}`
+ })}`,
);
reader.releaseLock();
diff --git a/examples/openapi-youtrack/README.md b/examples/openapi-youtrack/README.md
index 15c8cbffce1ed..4a38a82f8c632 100644
--- a/examples/openapi-youtrack/README.md
+++ b/examples/openapi-youtrack/README.md
@@ -8,12 +8,16 @@ This example takes YouTrack as API Source and generates GraphQL Schema
You should have a YouTrack instance and a valid token.
-See here; https://www.jetbrains.com/help/youtrack/standalone/Manage-Permanent-Token.html#obtain-permanent-token
+See here;
+https://www.jetbrains.com/help/youtrack/standalone/Manage-Permanent-Token.html#obtain-permanent-token
You need to pass two environmental variables to run this project with the command `yarn start`;
-- `YOUTRACK_SERVICE_URL` is your YouTrack service URL. If you are using the cloud, you have a URL something like this; `https://ardatan.myjetbrains.com/youtrack`
-- `YOUTRACK_TOKEN` is your YouTrack token to access YouTrack service using REST API. If it is a permenant token, it should be something like `perm:XXXXXX==XXXXXXX==XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`
+- `YOUTRACK_SERVICE_URL` is your YouTrack service URL. If you are using the cloud, you have a URL
+ something like this; `https://ardatan.myjetbrains.com/youtrack`
+- `YOUTRACK_TOKEN` is your YouTrack token to access YouTrack service using REST API. If it is a
+ permenant token, it should be something like
+ `perm:XXXXXX==XXXXXXX==XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX`
Then run this project with the following command;
diff --git a/examples/openwhisk-example/README.md b/examples/openwhisk-example/README.md
index 72e745a58a3cd..ab2a3ae305275 100644
--- a/examples/openwhisk-example/README.md
+++ b/examples/openwhisk-example/README.md
@@ -2,15 +2,16 @@
## Files
-- `src/index.ts` is the handler function for the OpenWhisk action that uses GraphQL Mesh's platform agnostic HTTP Handler
+- `src/index.ts` is the handler function for the OpenWhisk action that uses GraphQL Mesh's platform
+ agnostic HTTP Handler
- `.meshrc.yml` is the configuration file for GraphQL Mesh
- `package.json` is the package.json file that contains all the dependencies and scripts
- `build.js` is the code file that runs `ESBuild` to create a bundle for OpenWhisk deployment
## Configuring the project
-GraphQL Mesh needs to be aware of the path of the OpenWhisk action endpoint.
-So you need to configure `serve.endpoint` in `.meshrc.yml`;
+GraphQL Mesh needs to be aware of the path of the OpenWhisk action endpoint. So you need to
+configure `serve.endpoint` in `.meshrc.yml`;
```yaml filename=".meshrc.yaml"
serve:
@@ -19,14 +20,17 @@ serve:
endpoint: /api/v1/web/guest/mesh/swapi/graphql
```
-You also need to update the paths inside `index.ts` and `package.json` to match your OpenWhisk action name.
+You also need to update the paths inside `index.ts` and `package.json` to match your OpenWhisk
+action name.
## Building the project for deployment
-You can see an example script to bundle the project with `ESBuild` in `build.js`.
-`yarn build` will build the artifacts of GraphQL Mesh first then bundle all the code needed for the OpenWhisk action by taking `index.ts` as an endpoint.
+You can see an example script to bundle the project with `ESBuild` in `build.js`. `yarn build` will
+build the artifacts of GraphQL Mesh first then bundle all the code needed for the OpenWhisk action
+by taking `index.ts` as an endpoint.
-You can find the bundle in `dist/index.js` and deploy it either `yarn deploy` or manually with `wsk` like `wsk action update /guest/mesh/swapi --kind nodejs:16 dist/index.js --web raw`.
+You can find the bundle in `dist/index.js` and deploy it either `yarn deploy` or manually with `wsk`
+like `wsk action update /guest/mesh/swapi --kind nodejs:16 dist/index.js --web raw`.
> `--web raw` needs to be added to configure the action as a _raw_ web action.
diff --git a/examples/openwhisk-example/src/index.ts b/examples/openwhisk-example/src/index.ts
index abc06858cae09..cd9983ee8dc91 100644
--- a/examples/openwhisk-example/src/index.ts
+++ b/examples/openwhisk-example/src/index.ts
@@ -10,7 +10,7 @@ export const main = async function (params) {
headers: params.__ow_headers,
body: params.__ow_body ? Buffer.from(params.__ow_body, 'base64') : undefined,
},
- params
+ params,
);
const headers = {};
diff --git a/examples/postgres-geodb/README.md b/examples/postgres-geodb/README.md
index 01e84e8506158..c823e8deba690 100644
--- a/examples/postgres-geodb/README.md
+++ b/examples/postgres-geodb/README.md
@@ -2,10 +2,12 @@
This example takes two API sources and merges them together:
-1. Postgres GeoDB - a seed database of geo locations and their metadata (uses `postgraphile` handler)
+1. Postgres GeoDB - a seed database of geo locations and their metadata (uses `postgraphile`
+ handler)
2. GitHub GraphQL API - to fetch information about users and developers ((uses `graphql` handler))
-The two schemas are connected and let you search for locations, and then fetch developers that are located in that location according to their GitHub account.
+The two schemas are connected and let you search for locations, and then fetch developers that are
+located in that location according to their GitHub account.
You should be able to run the following query and get the linked data:
@@ -27,15 +29,19 @@ query locationsAndDevelopers {
## Getting Started
-Because a running Postgres DB is required, you need to setup local Postgres running, and load the schema and data seed.
+Because a running Postgres DB is required, you need to setup local Postgres running, and load the
+schema and data seed.
To do that, run the following:
-1. Install and run Postgres using Docker - `docker run --name pg-docker -e POSTGRES_PASSWORD=docker -d -p 5432:5432 postgres`
+1. Install and run Postgres using Docker -
+ `docker run --name pg-docker -e POSTGRES_PASSWORD=docker -d -p 5432:5432 postgres`
2. Install Postgres CLI: `brew upgrade postgresql` (or, you can use any of your favorite tool)
-3. Seed the DB with data: `curl https://raw.githubusercontent.com/morenoh149/postgresDBSamples/master/worldDB-1.0/world.sql | psql -h localhost -d postgres -U postgres`
+3. Seed the DB with data:
+ `curl https://raw.githubusercontent.com/morenoh149/postgresDBSamples/master/worldDB-1.0/world.sql | psql -h localhost -d postgres -U postgres`
-Now, to have access to the GitHub GraphQL API, start by creating a personal access token here: https://github.com/settings/tokens , and put it in an environment variable called `GH_ACCESS_TOKEN`.
+Now, to have access to the GitHub GraphQL API, start by creating a personal access token here:
+https://github.com/settings/tokens , and put it in an environment variable called `GH_ACCESS_TOKEN`.
Then you should be able to use the `mesh:serve` script to run it:
@@ -53,7 +59,8 @@ The following command will generate the fully type-safe SDK for you:
GH_ACCESS_TOKEN="your token here" yarn mesh:sdk
```
-You can find the code that uses the generates SDK under `./src/test.ts`, it imports for the generated code and prints the result nicely to the console. You can run it with:
+You can find the code that uses the generates SDK under `./src/test.ts`, it imports for the
+generated code and prints the result nicely to the console. You can run it with:
```sh
GH_ACCESS_TOKEN="your token here" yarn test:sdk
diff --git a/examples/programmatic-batching/example-api/app.ts b/examples/programmatic-batching/example-api/app.ts
index 74e9285cefa9d..cde36b9361ab5 100644
--- a/examples/programmatic-batching/example-api/app.ts
+++ b/examples/programmatic-batching/example-api/app.ts
@@ -24,7 +24,7 @@ export function createApp() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
});
diff --git a/examples/soap-country-info/tests/soap-country-info.spec.ts b/examples/soap-country-info/tests/soap-country-info.spec.ts
index 6196021d456db..b502add2f599f 100644
--- a/examples/soap-country-info/tests/soap-country-info.spec.ts
+++ b/examples/soap-country-info/tests/soap-country-info.spec.ts
@@ -23,7 +23,10 @@ describe('SOAP Country Info', () => {
expect(printSchemaWithDirectives(lexicographicSortSchema(mesh.schema))).toMatchSnapshot();
});
it('should give correct response for the batched example query', async () => {
- const queryStr = await readFile(join(__dirname, '..', 'list-of-languages-by-name.graphql'), 'utf-8');
+ const queryStr = await readFile(
+ join(__dirname, '..', 'list-of-languages-by-name.graphql'),
+ 'utf-8',
+ );
const result = await mesh.execute(queryStr, {});
expect(result?.errors?.[0]?.stack).toBeUndefined();
expect(result).toMatchSnapshot('list-of-languages-by-name-result');
diff --git a/examples/sqlite-chinook/tests/sqlite-chinook.test.js b/examples/sqlite-chinook/tests/sqlite-chinook.test.js
index 683d3fec832b8..dac959a963b63 100644
--- a/examples/sqlite-chinook/tests/sqlite-chinook.test.js
+++ b/examples/sqlite-chinook/tests/sqlite-chinook.test.js
@@ -16,7 +16,7 @@ describe('SQLite Chinook', () => {
expect(
introspectionFromSchema(lexicographicSortSchema(schema), {
descriptions: false,
- })
+ }),
).toMatchSnapshot('sqlite-chinook-schema');
});
it('should give correct response for example queries', async () => {
diff --git a/examples/thrift-calculator/src/codegen/AddRequest.ts b/examples/thrift-calculator/src/codegen/AddRequest.ts
index f77f3f6a43bd0..42b310a2d328b 100644
--- a/examples/thrift-calculator/src/codegen/AddRequest.ts
+++ b/examples/thrift-calculator/src/codegen/AddRequest.ts
@@ -25,14 +25,20 @@ export const AddRequestCodec: thrift.IStructCodec
output.writeI32(obj.left);
output.writeFieldEnd();
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[left] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[left] is unset!',
+ );
}
if (obj.right != null) {
output.writeFieldBegin('right', thrift.TType.I32, 2);
output.writeI32(obj.right);
output.writeFieldEnd();
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[right] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[right] is unset!',
+ );
}
output.writeFieldStop();
output.writeStructEnd();
@@ -80,7 +86,7 @@ export const AddRequestCodec: thrift.IStructCodec
} else {
throw new thrift.TProtocolException(
thrift.TProtocolExceptionType.UNKNOWN,
- 'Unable to read AddRequest from input'
+ 'Unable to read AddRequest from input',
);
}
},
@@ -96,13 +102,19 @@ export class AddRequest extends thrift.StructLike implements IAddRequest {
const value_3: number = args.left;
this.left = value_3;
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[left] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[left] is unset!',
+ );
}
if (args.right != null) {
const value_4: number = args.right;
this.right = value_4;
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[right] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[right] is unset!',
+ );
}
}
public static read(input: thrift.TProtocol): AddRequest {
diff --git a/examples/thrift-calculator/src/codegen/Calculator.ts b/examples/thrift-calculator/src/codegen/Calculator.ts
index 16b2e78e01bac..a68d1efe9f604 100644
--- a/examples/thrift-calculator/src/codegen/Calculator.ts
+++ b/examples/thrift-calculator/src/codegen/Calculator.ts
@@ -42,7 +42,10 @@ export const Add__ArgsCodec: thrift.IStructCodec = {
AddRequest.AddRequestCodec.encode(obj.request, output);
output.writeFieldEnd();
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[request] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[request] is unset!',
+ );
}
output.writeFieldStop();
output.writeStructEnd();
@@ -79,7 +82,10 @@ export const Add__ArgsCodec: thrift.IStructCodec = {
request: _args.request,
};
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Unable to read Add__Args from input');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Unable to read Add__Args from input',
+ );
}
},
};
@@ -93,7 +99,10 @@ export class Add__Args extends thrift.StructLike implements IAdd__Args {
const value_2: AddRequest.IAddRequest = new AddRequest.AddRequest(args.request);
this.request = value_2;
} else {
- throw new thrift.TProtocolException(thrift.TProtocolExceptionType.UNKNOWN, 'Required field[request] is unset!');
+ throw new thrift.TProtocolException(
+ thrift.TProtocolExceptionType.UNKNOWN,
+ 'Required field[request] is unset!',
+ );
}
}
public static read(input: thrift.TProtocol): Add__Args {
@@ -126,14 +135,20 @@ export const Subtract__ArgsCodec: thrift.IStructCodec = {
- encode(args: ISubtract__ResultArgs, output: thrift.TProtocol): void {
- const obj: any = {
- success: args.success,
- };
- output.writeStructBegin('Subtract__Result');
- if (obj.success != null) {
- output.writeFieldBegin('success', thrift.TType.I32, 0);
- output.writeI32(obj.success);
- output.writeFieldEnd();
- }
- output.writeFieldStop();
- output.writeStructEnd();
- return;
- },
- decode(input: thrift.TProtocol): ISubtract__Result {
- let _args: any = {};
- input.readStructBegin();
- while (true) {
- const ret: thrift.IThriftField = input.readFieldBegin();
- const fieldType: thrift.TType = ret.fieldType;
- const fieldId: number = ret.fieldId;
- if (fieldType === thrift.TType.STOP) {
- break;
+export const Subtract__ResultCodec: thrift.IStructCodec =
+ {
+ encode(args: ISubtract__ResultArgs, output: thrift.TProtocol): void {
+ const obj: any = {
+ success: args.success,
+ };
+ output.writeStructBegin('Subtract__Result');
+ if (obj.success != null) {
+ output.writeFieldBegin('success', thrift.TType.I32, 0);
+ output.writeI32(obj.success);
+ output.writeFieldEnd();
}
- switch (fieldId) {
- case 0:
- if (fieldType === thrift.TType.I32) {
- const value_9: number = input.readI32();
- _args.success = value_9;
- } else {
+ output.writeFieldStop();
+ output.writeStructEnd();
+ return;
+ },
+ decode(input: thrift.TProtocol): ISubtract__Result {
+ let _args: any = {};
+ input.readStructBegin();
+ while (true) {
+ const ret: thrift.IThriftField = input.readFieldBegin();
+ const fieldType: thrift.TType = ret.fieldType;
+ const fieldId: number = ret.fieldId;
+ if (fieldType === thrift.TType.STOP) {
+ break;
+ }
+ switch (fieldId) {
+ case 0:
+ if (fieldType === thrift.TType.I32) {
+ const value_9: number = input.readI32();
+ _args.success = value_9;
+ } else {
+ input.skip(fieldType);
+ }
+ break;
+ default: {
input.skip(fieldType);
}
- break;
- default: {
- input.skip(fieldType);
}
+ input.readFieldEnd();
}
- input.readFieldEnd();
- }
- input.readStructEnd();
- return {
- success: _args.success,
- };
- },
-};
+ input.readStructEnd();
+ return {
+ success: _args.success,
+ };
+ },
+ };
export class Subtract__Result extends thrift.StructLike implements ISubtract__Result {
public success?: number;
public readonly _annotations: thrift.IThriftAnnotations = {};
@@ -385,10 +407,12 @@ export class Client extends thrift.ThriftClient {
const reader: thrift.TTransport = this.transport.receiver(data);
const input: thrift.TProtocol = new this.protocol(reader);
try {
- const { fieldName: fieldName, messageType: messageType }: thrift.IThriftMessage = input.readMessageBegin();
+ const { fieldName: fieldName, messageType: messageType }: thrift.IThriftMessage =
+ input.readMessageBegin();
if (fieldName === 'add') {
if (messageType === thrift.MessageType.EXCEPTION) {
- const err: thrift.TApplicationException = thrift.TApplicationExceptionCodec.decode(input);
+ const err: thrift.TApplicationException =
+ thrift.TApplicationExceptionCodec.decode(input);
input.readMessageEnd();
return Promise.reject(err);
} else {
@@ -398,7 +422,10 @@ export class Client extends thrift.ThriftClient {
return Promise.resolve(result.success);
} else {
return Promise.reject(
- new thrift.TApplicationException(thrift.TApplicationExceptionType.UNKNOWN, 'add failed: unknown result')
+ new thrift.TApplicationException(
+ thrift.TApplicationExceptionType.UNKNOWN,
+ 'add failed: unknown result',
+ ),
);
}
}
@@ -406,8 +433,8 @@ export class Client extends thrift.ThriftClient {
return Promise.reject(
new thrift.TApplicationException(
thrift.TApplicationExceptionType.WRONG_METHOD_NAME,
- 'Received a response to an unknown RPC function: ' + fieldName
- )
+ 'Received a response to an unknown RPC function: ' + fieldName,
+ ),
);
}
} catch (err) {
@@ -426,10 +453,12 @@ export class Client extends thrift.ThriftClient {
const reader: thrift.TTransport = this.transport.receiver(data);
const input: thrift.TProtocol = new this.protocol(reader);
try {
- const { fieldName: fieldName, messageType: messageType }: thrift.IThriftMessage = input.readMessageBegin();
+ const { fieldName: fieldName, messageType: messageType }: thrift.IThriftMessage =
+ input.readMessageBegin();
if (fieldName === 'subtract') {
if (messageType === thrift.MessageType.EXCEPTION) {
- const err: thrift.TApplicationException = thrift.TApplicationExceptionCodec.decode(input);
+ const err: thrift.TApplicationException =
+ thrift.TApplicationExceptionCodec.decode(input);
input.readMessageEnd();
return Promise.reject(err);
} else {
@@ -441,8 +470,8 @@ export class Client extends thrift.ThriftClient {
return Promise.reject(
new thrift.TApplicationException(
thrift.TApplicationExceptionType.UNKNOWN,
- 'subtract failed: unknown result'
- )
+ 'subtract failed: unknown result',
+ ),
);
}
}
@@ -450,8 +479,8 @@ export class Client extends thrift.ThriftClient {
return Promise.reject(
new thrift.TApplicationException(
thrift.TApplicationExceptionType.WRONG_METHOD_NAME,
- 'Received a response to an unknown RPC function: ' + fieldName
- )
+ 'Received a response to an unknown RPC function: ' + fieldName,
+ ),
);
}
} catch (err) {
@@ -478,7 +507,11 @@ export class Processor extends thrift.ThriftProcessor {
+ public process(
+ input: thrift.TProtocol,
+ output: thrift.TProtocol,
+ context: Context,
+ ): Promise {
return new Promise((resolve, reject): void => {
const metadata: thrift.IThriftMessage = input.readMessageBegin();
const fieldName: string = metadata.fieldName;
@@ -497,7 +530,10 @@ export class Processor extends thrift.ThriftProcessor extends thrift.ThriftProcessor {
return new Promise((resolve, reject): void => {
try {
@@ -532,7 +568,7 @@ export class Processor extends thrift.ThriftProcessor {
const result: thrift.TApplicationException = new thrift.TApplicationException(
thrift.TApplicationExceptionType.UNKNOWN,
- err.message
+ err.message,
);
output.writeMessageBegin('add', thrift.MessageType.EXCEPTION, requestId);
thrift.TApplicationExceptionCodec.encode(result, output);
@@ -544,7 +580,7 @@ export class Processor extends thrift.ThriftProcessor {
return new Promise((resolve, reject): void => {
try {
@@ -565,7 +601,7 @@ export class Processor extends thrift.ThriftProcessor {
const result: thrift.TApplicationException = new thrift.TApplicationException(
thrift.TApplicationExceptionType.UNKNOWN,
- err.message
+ err.message,
);
output.writeMessageBegin('subtract', thrift.MessageType.EXCEPTION, requestId);
thrift.TApplicationExceptionCodec.encode(result, output);
diff --git a/examples/thrift-calculator/tests/thrift-calculator.test.ts b/examples/thrift-calculator/tests/thrift-calculator.test.ts
index c9683c21d9122..7c36d90c87cba 100644
--- a/examples/thrift-calculator/tests/thrift-calculator.test.ts
+++ b/examples/thrift-calculator/tests/thrift-calculator.test.ts
@@ -26,7 +26,7 @@ describe('Thrift Calculator', () => {
expect(
introspectionFromSchema(lexicographicSortSchema(schema), {
descriptions: false,
- })
+ }),
).toMatchSnapshot('thrift-calculator-schema');
});
it('should give correct response for example queries', async () => {
diff --git a/examples/type-merging-batching-example/author-service-schema.ts b/examples/type-merging-batching-example/author-service-schema.ts
index 72a15f4d957a2..119de10fe764b 100644
--- a/examples/type-merging-batching-example/author-service-schema.ts
+++ b/examples/type-merging-batching-example/author-service-schema.ts
@@ -43,7 +43,8 @@ export default new GraphQLSchema({
type: new GraphQLList(GraphQLID),
},
},
- resolve: (_, { ids }) => (ids ? ids.map(id => authors.find(author => author.id === id)) : authors),
+ resolve: (_, { ids }) =>
+ ids ? ids.map(id => authors.find(author => author.id === id)) : authors,
},
},
}),
diff --git a/packages/apollo-link/CHANGELOG.md b/packages/apollo-link/CHANGELOG.md
index 2e02673f760df..a0788cd185515 100644
--- a/packages/apollo-link/CHANGELOG.md
+++ b/packages/apollo-link/CHANGELOG.md
@@ -4,134 +4,213 @@
### Patch Changes
-- [#4790](https://github.com/Urigo/graphql-mesh/pull/4790) [`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
-
- - Updated dependency [`@graphql-tools/utils@9.1.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.0) (from `9.0.1`, in `dependencies`)
-
-- [#4809](https://github.com/Urigo/graphql-mesh/pull/4809) [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@9.1.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.1) (from `9.1.0`, in `dependencies`)
-- Updated dependencies [[`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65), [`990f649ef`](https://github.com/Urigo/graphql-mesh/commit/990f649ef8832bc786b89b0c15744d49a422bb03), [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33), [`7390ca341`](https://github.com/Urigo/graphql-mesh/commit/7390ca341c9135625f89f1e03a9d15938880154e)]:
+- [#4790](https://github.com/Urigo/graphql-mesh/pull/4790)
+ [`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+
+ - Updated dependency
+ [`@graphql-tools/utils@9.1.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.0)
+ (from `9.0.1`, in `dependencies`)
+
+- [#4809](https://github.com/Urigo/graphql-mesh/pull/4809)
+ [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@9.1.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.1)
+ (from `9.1.0`, in `dependencies`)
+- Updated dependencies
+ [[`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65),
+ [`990f649ef`](https://github.com/Urigo/graphql-mesh/commit/990f649ef8832bc786b89b0c15744d49a422bb03),
+ [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33),
+ [`7390ca341`](https://github.com/Urigo/graphql-mesh/commit/7390ca341c9135625f89f1e03a9d15938880154e)]:
- @graphql-mesh/runtime@0.44.32
## 8.0.6
### Patch Changes
-- [#4775](https://github.com/Urigo/graphql-mesh/pull/4775) [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@9.0.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.0.1) (from `8.13.1`, in `dependencies`)
-- Updated dependencies [[`d9c5c1195`](https://github.com/Urigo/graphql-mesh/commit/d9c5c119522a1c4cad455d62818e07a2b8f41005), [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a), [`85e5071d0`](https://github.com/Urigo/graphql-mesh/commit/85e5071d084d5372830213511f55f4a30a17bb33), [`9a56eb45b`](https://github.com/Urigo/graphql-mesh/commit/9a56eb45bcbaa1eb58d9d7537b5d08ca4fef658f)]:
+- [#4775](https://github.com/Urigo/graphql-mesh/pull/4775)
+ [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@9.0.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.0.1)
+ (from `8.13.1`, in `dependencies`)
+- Updated dependencies
+ [[`d9c5c1195`](https://github.com/Urigo/graphql-mesh/commit/d9c5c119522a1c4cad455d62818e07a2b8f41005),
+ [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a),
+ [`85e5071d0`](https://github.com/Urigo/graphql-mesh/commit/85e5071d084d5372830213511f55f4a30a17bb33),
+ [`9a56eb45b`](https://github.com/Urigo/graphql-mesh/commit/9a56eb45bcbaa1eb58d9d7537b5d08ca4fef658f)]:
- @graphql-mesh/runtime@0.44.31
## 8.0.5
### Patch Changes
-- [#4765](https://github.com/Urigo/graphql-mesh/pull/4765) [`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.13.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.1) (from `8.13.0`, in `dependencies`)
-- Updated dependencies [[`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a)]:
+- [#4765](https://github.com/Urigo/graphql-mesh/pull/4765)
+ [`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@8.13.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.1)
+ (from `8.13.0`, in `dependencies`)
+- Updated dependencies
+ [[`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a)]:
- @graphql-mesh/runtime@0.44.30
## 8.0.4
### Patch Changes
-- [#4745](https://github.com/Urigo/graphql-mesh/pull/4745) [`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.13.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.0) (from `8.12.0`, in `dependencies`)
-- Updated dependencies [[`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd), [`305dd2262`](https://github.com/Urigo/graphql-mesh/commit/305dd2262054f4173384c0af8f90e8879411bbe0)]:
+- [#4745](https://github.com/Urigo/graphql-mesh/pull/4745)
+ [`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@8.13.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.0)
+ (from `8.12.0`, in `dependencies`)
+- Updated dependencies
+ [[`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd),
+ [`305dd2262`](https://github.com/Urigo/graphql-mesh/commit/305dd2262054f4173384c0af8f90e8879411bbe0)]:
- @graphql-mesh/runtime@0.44.28
## 8.0.3
### Patch Changes
-- [`0bbd55cdd`](https://github.com/Urigo/graphql-mesh/commit/0bbd55cdd5e1428ade1223950ac1d7fca255cdff) Thanks [@ardatan](https://github.com/ardatan)! - Fix apollo import
+- [`0bbd55cdd`](https://github.com/Urigo/graphql-mesh/commit/0bbd55cdd5e1428ade1223950ac1d7fca255cdff)
+ Thanks [@ardatan](https://github.com/ardatan)! - Fix apollo import
-- Updated dependencies [[`ffb301435`](https://github.com/Urigo/graphql-mesh/commit/ffb3014353c17d23a03cf8001eba606c85c2043f)]:
+- Updated dependencies
+ [[`ffb301435`](https://github.com/Urigo/graphql-mesh/commit/ffb3014353c17d23a03cf8001eba606c85c2043f)]:
- @graphql-mesh/runtime@0.44.16
## 8.0.2
### Patch Changes
-- [#4439](https://github.com/Urigo/graphql-mesh/pull/4439) [`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2) Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
+- [#4439](https://github.com/Urigo/graphql-mesh/pull/4439)
+ [`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2)
+ Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0) (from `8.10.1`, in `dependencies`)
- - Updated dependency [`@graphql-mesh/runtime@^0.44.3` ↗︎](https://www.npmjs.com/package/@graphql-mesh/runtime/v/null) (from `^0.43.0`, in `peerDependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0)
+ (from `8.10.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-mesh/runtime@^0.44.3` ↗︎](https://www.npmjs.com/package/@graphql-mesh/runtime/v/null)
+ (from `^0.43.0`, in `peerDependencies`)
-- Updated dependencies [[`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2), [`317f6b454`](https://github.com/Urigo/graphql-mesh/commit/317f6b454db59e351cf6360df5575248cb579dd4)]:
+- Updated dependencies
+ [[`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2),
+ [`317f6b454`](https://github.com/Urigo/graphql-mesh/commit/317f6b454db59e351cf6360df5575248cb579dd4)]:
- @graphql-mesh/runtime@0.44.4
## 8.0.1
### Patch Changes
-- [#4466](https://github.com/Urigo/graphql-mesh/pull/4466) [`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4466](https://github.com/Urigo/graphql-mesh/pull/4466)
+ [`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0) (from `8.11.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0)
+ (from `8.11.0`, in `dependencies`)
-- Updated dependencies [[`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f)]:
+- Updated dependencies
+ [[`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f)]:
- @graphql-mesh/runtime@0.44.3
## 8.0.0
### Patch Changes
-- Updated dependencies [[`24afabece`](https://github.com/Urigo/graphql-mesh/commit/24afabece51aee171f902776d3f59b4a17026c49), [`44b868196`](https://github.com/Urigo/graphql-mesh/commit/44b86819695a298e60b1d7b6c54ae2772e8f1588)]:
+- Updated dependencies
+ [[`24afabece`](https://github.com/Urigo/graphql-mesh/commit/24afabece51aee171f902776d3f59b4a17026c49),
+ [`44b868196`](https://github.com/Urigo/graphql-mesh/commit/44b86819695a298e60b1d7b6c54ae2772e8f1588)]:
- @graphql-mesh/runtime@0.44.0
## 7.0.1
### Patch Changes
-- [#4443](https://github.com/Urigo/graphql-mesh/pull/4443) [`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4443](https://github.com/Urigo/graphql-mesh/pull/4443)
+ [`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.11.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.11.0) (from `8.10.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.11.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.11.0)
+ (from `8.10.1`, in `dependencies`)
-- Updated dependencies [[`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53)]:
+- Updated dependencies
+ [[`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53)]:
- @graphql-mesh/runtime@0.43.4
## 7.0.0
### Patch Changes
-- [#4380](https://github.com/Urigo/graphql-mesh/pull/4380) [`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd) Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
+- [#4380](https://github.com/Urigo/graphql-mesh/pull/4380)
+ [`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd)
+ Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1) (from `8.10.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1)
+ (from `8.10.0`, in `dependencies`)
-- [#4389](https://github.com/Urigo/graphql-mesh/pull/4389) [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4389](https://github.com/Urigo/graphql-mesh/pull/4389)
+ [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1) (from `8.10.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1)
+ (from `8.10.0`, in `dependencies`)
-- Updated dependencies [[`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd), [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f), [`d87907736`](https://github.com/Urigo/graphql-mesh/commit/d87907736588520628acb32d9a83e3d39dba7b2f), [`d87907736`](https://github.com/Urigo/graphql-mesh/commit/d87907736588520628acb32d9a83e3d39dba7b2f), [`15f315959`](https://github.com/Urigo/graphql-mesh/commit/15f315959f4eb70327e3df4c97fa081b75021f5f)]:
+- Updated dependencies
+ [[`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd),
+ [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f),
+ [`d87907736`](https://github.com/Urigo/graphql-mesh/commit/d87907736588520628acb32d9a83e3d39dba7b2f),
+ [`d87907736`](https://github.com/Urigo/graphql-mesh/commit/d87907736588520628acb32d9a83e3d39dba7b2f),
+ [`15f315959`](https://github.com/Urigo/graphql-mesh/commit/15f315959f4eb70327e3df4c97fa081b75021f5f)]:
- @graphql-mesh/runtime@0.43.0
## 6.0.0
### Patch Changes
-- Updated dependencies [[`209717f0b`](https://github.com/Urigo/graphql-mesh/commit/209717f0b87a56326cfd37fb9f26cb1ccbc47b1a), [`209717f0b`](https://github.com/Urigo/graphql-mesh/commit/209717f0b87a56326cfd37fb9f26cb1ccbc47b1a)]:
+- Updated dependencies
+ [[`209717f0b`](https://github.com/Urigo/graphql-mesh/commit/209717f0b87a56326cfd37fb9f26cb1ccbc47b1a),
+ [`209717f0b`](https://github.com/Urigo/graphql-mesh/commit/209717f0b87a56326cfd37fb9f26cb1ccbc47b1a)]:
- @graphql-mesh/runtime@0.42.0
## 5.0.2
### Patch Changes
-- [#4275](https://github.com/Urigo/graphql-mesh/pull/4275) [`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4275](https://github.com/Urigo/graphql-mesh/pull/4275)
+ [`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.0) (was `8.9.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.0)
+ (was `8.9.1`, in `dependencies`)
-- Updated dependencies [[`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2), [`991373717`](https://github.com/Urigo/graphql-mesh/commit/99137371708b7fe12b32dfcfe93d535507a7f968)]:
+- Updated dependencies
+ [[`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2),
+ [`991373717`](https://github.com/Urigo/graphql-mesh/commit/99137371708b7fe12b32dfcfe93d535507a7f968)]:
- @graphql-mesh/runtime@0.41.9
## 5.0.1
### Patch Changes
-- [#4263](https://github.com/Urigo/graphql-mesh/pull/4263) [`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4263](https://github.com/Urigo/graphql-mesh/pull/4263)
+ [`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.9.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.9.1) (was `8.9.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.9.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.9.1)
+ (was `8.9.0`, in `dependencies`)
-- Updated dependencies [[`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73)]:
+- Updated dependencies
+ [[`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73)]:
- @graphql-mesh/runtime@0.41.8
## 5.0.0
diff --git a/packages/apollo-link/src/index.ts b/packages/apollo-link/src/index.ts
index 6296476217cc9..b5232d5461074 100644
--- a/packages/apollo-link/src/index.ts
+++ b/packages/apollo-link/src/index.ts
@@ -15,7 +15,8 @@ function createMeshApolloRequestHandler(options: MeshApolloRequestHandlerOptions
if (!operationAst) {
throw new Error('GraphQL operation not found');
}
- const operationFn = operationAst.operation === 'subscription' ? options.subscribe : options.execute;
+ const operationFn =
+ operationAst.operation === 'subscription' ? options.subscribe : options.execute;
return new Observable(observer => {
Promise.resolve()
.then(async () => {
@@ -24,7 +25,7 @@ function createMeshApolloRequestHandler(options: MeshApolloRequestHandlerOptions
operation.variables,
operation.getContext(),
ROOT_VALUE,
- operation.operationName
+ operation.operationName,
);
if (isAsyncIterable(results)) {
for await (const result of results) {
diff --git a/packages/apollo-link/test/apollo-link.test.ts b/packages/apollo-link/test/apollo-link.test.ts
index f05d5a522e66f..56a2cd153f6bc 100644
--- a/packages/apollo-link/test/apollo-link.test.ts
+++ b/packages/apollo-link/test/apollo-link.test.ts
@@ -41,7 +41,9 @@ describe('GraphApolloLink', () => {
`),
});
const asyncIterable =
- observableToAsyncIterable, Record>>(observable);
+ observableToAsyncIterable, Record>>(
+ observable,
+ );
let i = 0;
for await (const result of asyncIterable) {
i++;
diff --git a/packages/cache/localforage/src/InMemoryLRUDriver.ts b/packages/cache/localforage/src/InMemoryLRUDriver.ts
index 65eb4c5f9b3e6..0667c299d7297 100644
--- a/packages/cache/localforage/src/InMemoryLRUDriver.ts
+++ b/packages/cache/localforage/src/InMemoryLRUDriver.ts
@@ -31,7 +31,11 @@ export function createInMemoryLRUDriver(ttl?: number): LocalForageDriver {
}
},
- async setItem(key: string, value: T, callback?: (err?: any, value?: any) => void): Promise {
+ async setItem(
+ key: string,
+ value: T,
+ callback?: (err?: any, value?: any) => void,
+ ): Promise {
try {
await nextTick();
lru.set(key, value);
@@ -125,7 +129,7 @@ export function createInMemoryLRUDriver(ttl?: number): LocalForageDriver {
async iterate(
iteratee: (value: T, key: string, iterationNumber: number) => any,
- callback?: (err?: any, result?: any) => void
+ callback?: (err?: any, result?: any) => void,
): Promise {
try {
await nextTick();
diff --git a/packages/cache/localforage/src/index.ts b/packages/cache/localforage/src/index.ts
index 8feead45da729..008c2ed474703 100644
--- a/packages/cache/localforage/src/index.ts
+++ b/packages/cache/localforage/src/index.ts
@@ -3,7 +3,7 @@ import { createInMemoryLRUDriver } from './InMemoryLRUDriver.js';
import LocalForage from 'localforage';
LocalForage.defineDriver(createInMemoryLRUDriver()).catch(err =>
- console.error('Failed at defining InMemoryLRU driver', err)
+ console.error('Failed at defining InMemoryLRU driver', err),
);
export default class LocalforageCache implements KeyValueCache {
diff --git a/packages/cache/redis/src/index.ts b/packages/cache/redis/src/index.ts
index c19fcc761bdb2..a3a8288e6a2e6 100644
--- a/packages/cache/redis/src/index.ts
+++ b/packages/cache/redis/src/index.ts
@@ -1,4 +1,9 @@
-import { KeyValueCache, KeyValueCacheSetOptions, MeshPubSub, YamlConfig } from '@graphql-mesh/types';
+import {
+ KeyValueCache,
+ KeyValueCacheSetOptions,
+ MeshPubSub,
+ YamlConfig,
+} from '@graphql-mesh/types';
import Redis from 'ioredis';
import { stringInterpolator } from '@graphql-mesh/string-interpolation';
import { process } from '@graphql-mesh/cross-helpers';
diff --git a/packages/cache/redis/test/cache.spec.ts b/packages/cache/redis/test/cache.spec.ts
index be751e12a248f..5a047697bc42f 100644
--- a/packages/cache/redis/test/cache.spec.ts
+++ b/packages/cache/redis/test/cache.spec.ts
@@ -20,7 +20,7 @@ describe('redis', () => {
new RedisCache({ url: 'redis://password@localhost:6379', pubsub });
expect(Redis).toHaveBeenCalledWith(
- 'redis://password@localhost:6379?lazyConnect=true&enableAutoPipelining=true&enableOfflineQueue=true'
+ 'redis://password@localhost:6379?lazyConnect=true&enableAutoPipelining=true&enableOfflineQueue=true',
);
});
@@ -41,7 +41,7 @@ describe('redis', () => {
new RedisCache({ url: 'redis://localhost:6379', host: 'ignoreme', port: '9999', pubsub });
expect(Redis).toHaveBeenCalledWith(
- 'redis://localhost:6379?lazyConnect=true&enableAutoPipelining=true&enableOfflineQueue=true'
+ 'redis://localhost:6379?lazyConnect=true&enableAutoPipelining=true&enableOfflineQueue=true',
);
});
@@ -51,7 +51,7 @@ describe('redis', () => {
expect(() => {
new RedisCache({ url: `${protocol}localhost:6379`, pubsub });
}).toThrowError('Redis URL must use either redis:// or rediss://');
- }
+ },
);
});
});
diff --git a/packages/cli/src/bin.ts b/packages/cli/src/bin.ts
index 8f29ad1f5503a..69f0c8b2ac3e6 100644
--- a/packages/cli/src/bin.ts
+++ b/packages/cli/src/bin.ts
@@ -4,5 +4,5 @@ import { graphqlMesh, DEFAULT_CLI_PARAMS } from '.';
import { handleFatalError } from './handleFatalError.js';
graphqlMesh(DEFAULT_CLI_PARAMS).catch(e =>
- handleFatalError(e, new DefaultLogger(DEFAULT_CLI_PARAMS.initialLoggerPrefix))
+ handleFatalError(e, new DefaultLogger(DEFAULT_CLI_PARAMS.initialLoggerPrefix)),
);
diff --git a/packages/cli/src/commands/generate-operations.ts b/packages/cli/src/commands/generate-operations.ts
index 9545dc5cc4f67..3010b5b325722 100644
--- a/packages/cli/src/commands/generate-operations.ts
+++ b/packages/cli/src/commands/generate-operations.ts
@@ -1,8 +1,16 @@
import type { YamlConfig } from '@graphql-mesh/types';
-import { buildOperationNodeForField, getRootTypeMap, parseGraphQLSDL, Source } from '@graphql-tools/utils';
+import {
+ buildOperationNodeForField,
+ getRootTypeMap,
+ parseGraphQLSDL,
+ Source,
+} from '@graphql-tools/utils';
import { GraphQLSchema, print } from 'graphql';
-export function generateOperations(schema: GraphQLSchema, options: YamlConfig.GenerateOperationsConfig): Source[] {
+export function generateOperations(
+ schema: GraphQLSchema,
+ options: YamlConfig.GenerateOperationsConfig,
+): Source[] {
const sources: Source[] = [];
const rootTypeMap = getRootTypeMap(schema);
for (const [operationType, rootType] of rootTypeMap) {
diff --git a/packages/cli/src/commands/ts-artifacts.ts b/packages/cli/src/commands/ts-artifacts.ts
index 42c78480ea8fd..9d3277812d942 100644
--- a/packages/cli/src/commands/ts-artifacts.ts
+++ b/packages/cli/src/commands/ts-artifacts.ts
@@ -29,7 +29,7 @@ class CodegenHelpers extends tsBasePlugin.TsVisitor {
function buildSignatureBasedOnRootFields(
codegenHelpers: CodegenHelpers,
- type: Maybe
+ type: Maybe,
): Record {
if (!type) {
return {};
@@ -52,7 +52,7 @@ function buildSignatureBasedOnRootFields(
operationMap[fieldName] = ` /** ${field.description} **/\n ${
field.name
}: InContextSdkMethod<${codegenHelpers.getTypeToUse(
- parentTypeNode
+ parentTypeNode,
)}['${fieldName}'], ${argsName}, ${unifiedContextIdentifier}>`;
}
return operationMap;
@@ -87,11 +87,17 @@ async function generateTypesForApi(options: {
});
const codegenHelpers = new CodegenHelpers(options.schema, config, {});
const namespace = pascalCase(`${options.name}Types`);
- const queryOperationMap = buildSignatureBasedOnRootFields(codegenHelpers, options.schema.getQueryType());
- const mutationOperationMap = buildSignatureBasedOnRootFields(codegenHelpers, options.schema.getMutationType());
+ const queryOperationMap = buildSignatureBasedOnRootFields(
+ codegenHelpers,
+ options.schema.getQueryType(),
+ );
+ const mutationOperationMap = buildSignatureBasedOnRootFields(
+ codegenHelpers,
+ options.schema.getMutationType(),
+ );
const subscriptionsOperationMap = buildSignatureBasedOnRootFields(
codegenHelpers,
- options.schema.getSubscriptionType()
+ options.schema.getSubscriptionType(),
);
const codeAst = `
@@ -113,7 +119,9 @@ export namespace ${namespace} {
};
export type Context = {
- [${JSON.stringify(options.name)}]: { Query: QuerySdk, Mutation: MutationSdk, Subscription: SubscriptionSdk },
+ [${JSON.stringify(
+ options.name,
+ )}]: { Query: QuerySdk, Mutation: MutationSdk, Subscription: SubscriptionSdk },
${Object.keys(options.contextVariables)
.map(key => `[${JSON.stringify(key)}]: ${options.contextVariables[key]}`)
.join(',\n')}
@@ -159,7 +167,7 @@ export async function generateTsArtifacts(
fileType: 'ts' | 'json' | 'js';
codegenConfig: any;
},
- cliParams: GraphQLMeshCLIParams
+ cliParams: GraphQLMeshCLIParams,
) {
const artifactsDir = pathModule.join(baseDir, cliParams.artifactsDir);
logger.info('Generating index file in TypeScript');
@@ -195,7 +203,7 @@ export async function generateTsArtifacts(
documentMode: 'external',
importDocumentNodeExternallyFrom: 'NOWHERE',
},
- }
+ },
);
}
const codegenOutput =
@@ -240,7 +248,10 @@ export async function generateTsArtifacts(
]);
const results = await Promise.all(
rawSources.map(async source => {
- const sourceMap = unifiedSchema.extensions.sourceMap as Map;
+ const sourceMap = unifiedSchema.extensions.sourceMap as Map<
+ RawSourceOutput,
+ GraphQLSchema
+ >;
const sourceSchema = sourceMap.get(source);
const { identifier, codeAst } = await generateTypesForApi({
schema: sourceSchema,
@@ -250,18 +261,23 @@ export async function generateTsArtifacts(
if (codeAst) {
const content = '// @ts-nocheck\n' + codeAst;
- await writeFile(pathModule.join(artifactsDir, `sources/${source.name}/types.ts`), content);
+ await writeFile(
+ pathModule.join(artifactsDir, `sources/${source.name}/types.ts`),
+ content,
+ );
}
if (identifier) {
- importCodes.add(`import type { ${identifier} } from './sources/${source.name}/types';`);
+ importCodes.add(
+ `import type { ${identifier} } from './sources/${source.name}/types';`,
+ );
}
return {
identifier,
codeAst,
};
- })
+ }),
);
const contextType = `export type ${unifiedContextIdentifier} = ${results
@@ -283,7 +299,10 @@ const importFn: ImportFn = (moduleId: string) => {
}
if (pathModule.isAbsolute(importPath)) {
moduleMapProp = pathModule.relative(baseDir, importedModuleName).split('\\').join('/');
- importPath = `./${pathModule.relative(artifactsDir, importedModuleName).split('\\').join('/')}`;
+ importPath = `./${pathModule
+ .relative(artifactsDir, importedModuleName)
+ .split('\\')
+ .join('/')}`;
}
return `
case ${JSON.stringify(moduleMapProp)}:
@@ -354,11 +373,11 @@ export function ${cliParams.builtMeshSDKFactoryName} async () => {
logger.info('Writing index.ts for ESM to the disk.');
- await writeFile(tsFilePath, codegenOutput.replace(BASEDIR_ASSIGNMENT_COMMENT, baseUrlAssignmentESM));
+ await writeFile(
+ tsFilePath,
+ codegenOutput.replace(BASEDIR_ASSIGNMENT_COMMENT, baseUrlAssignmentESM),
+ );
const esmJsFilePath = pathModule.join(artifactsDir, `index.${ext}`);
if (await pathExists(esmJsFilePath)) {
@@ -392,7 +414,10 @@ const baseDir = pathModule.join(pathModule.dirname(fileURLToPath(import.meta.url
const cjsJob = async () => {
logger.info('Writing index.ts for CJS to the disk.');
- await writeFile(tsFilePath, codegenOutput.replace(BASEDIR_ASSIGNMENT_COMMENT, baseUrlAssignmentCJS));
+ await writeFile(
+ tsFilePath,
+ codegenOutput.replace(BASEDIR_ASSIGNMENT_COMMENT, baseUrlAssignmentCJS),
+ );
if (await pathExists(jsFilePath)) {
await fs.promises.unlink(jsFilePath);
diff --git a/packages/cli/src/config.ts b/packages/cli/src/config.ts
index 8b5f21a642aff..ce2d4f89b4747 100644
--- a/packages/cli/src/config.ts
+++ b/packages/cli/src/config.ts
@@ -10,7 +10,7 @@ export function validateConfig(
config: any,
filepath: string,
initialLoggerPrefix: string,
- throwOnInvalidConfig = false
+ throwOnInvalidConfig = false,
): asserts config is YamlConfig.Config {
const ajv = new Ajv({
strict: false,
@@ -25,7 +25,7 @@ export function validateConfig(
error.stack += `\n at ${filepath}:0:0`;
return error;
}),
- 'Configuration file is not valid'
+ 'Configuration file is not valid',
);
throw aggregateError;
}
@@ -80,7 +80,11 @@ export async function findAndParseConfig(options?: ConfigProcessOptions) {
return processConfig(config, { dir, initialLoggerPrefix, importFn, ...restOptions });
}
-function customLoader(ext: 'json' | 'yaml' | 'js', importFn = defaultImportFn, initialLoggerPrefix = '🕸️ Mesh') {
+function customLoader(
+ ext: 'json' | 'yaml' | 'js',
+ importFn = defaultImportFn,
+ initialLoggerPrefix = '🕸️ Mesh',
+) {
const logger = new DefaultLogger(initialLoggerPrefix).child('config');
function loader(filepath: string, content: string) {
if (process.env) {
diff --git a/packages/config/src/getAdditionalResolversFromTypeDefs.ts b/packages/config/src/getAdditionalResolversFromTypeDefs.ts
index 5b214ad9cd4f1..d272d1ef415b2 100644
--- a/packages/config/src/getAdditionalResolversFromTypeDefs.ts
+++ b/packages/config/src/getAdditionalResolversFromTypeDefs.ts
@@ -1,5 +1,12 @@
import { resolveAdditionalResolvers } from '@graphql-mesh/utils';
-import { ConstValueNode, DocumentNode, Kind, ConstObjectValueNode, visit, FieldDefinitionNode } from 'graphql';
+import {
+ ConstValueNode,
+ DocumentNode,
+ Kind,
+ ConstObjectValueNode,
+ visit,
+ FieldDefinitionNode,
+} from 'graphql';
function parseObject(ast: ConstObjectValueNode): any {
const value = Object.create(null);
@@ -56,10 +63,14 @@ export function getAdditionalResolversFromTypeDefs(additionalTypeDefs: DocumentN
objectNode.fields?.forEach(fieldNode => handleFieldNode(objectNode.name.value, fieldNode));
},
InterfaceTypeDefinition(interfaceNode) {
- interfaceNode.fields?.forEach(fieldNode => handleFieldNode(interfaceNode.name.value, fieldNode));
+ interfaceNode.fields?.forEach(fieldNode =>
+ handleFieldNode(interfaceNode.name.value, fieldNode),
+ );
},
InterfaceTypeExtension(interfaceNode) {
- interfaceNode.fields?.forEach(fieldNode => handleFieldNode(interfaceNode.name.value, fieldNode));
+ interfaceNode.fields?.forEach(fieldNode =>
+ handleFieldNode(interfaceNode.name.value, fieldNode),
+ );
},
});
});
diff --git a/packages/config/src/process.ts b/packages/config/src/process.ts
index e1a9feae582c2..c3fdeba01ebc5 100644
--- a/packages/config/src/process.ts
+++ b/packages/config/src/process.ts
@@ -79,7 +79,7 @@ function getDefaultMeshStore(dir: string, importFn: ImportFn, artifactsDir: stri
export async function processConfig(
config: YamlConfig.Config,
- options?: ConfigProcessOptions
+ options?: ConfigProcessOptions,
): Promise {
if (config.skipSSLValidation) {
process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
@@ -90,7 +90,9 @@ export async function processConfig(
`import type { YamlConfig } from '@graphql-mesh/types';`,
]);
const codes = new Set([
- `export const rawServeConfig: YamlConfig.Config['serve'] = ${JSON.stringify(config.serve)} as any`,
+ `export const rawServeConfig: YamlConfig.Config['serve'] = ${JSON.stringify(
+ config.serve,
+ )} as any`,
`export async function getMeshOptions(): Promise {`,
]);
@@ -126,7 +128,13 @@ export async function processConfig(
logger,
importCode: loggerImportCode,
code: loggerCode,
- } = await resolveLogger(config.logger, importFn, dir, additionalPackagePrefixes, options?.initialLoggerPrefix);
+ } = await resolveLogger(
+ config.logger,
+ importFn,
+ dir,
+ additionalPackagePrefixes,
+ options?.initialLoggerPrefix,
+ );
importCodes.add(loggerImportCode);
codes.add(loggerCode);
@@ -134,7 +142,15 @@ export async function processConfig(
cache,
importCode: cacheImportCode,
code: cacheCode,
- } = await resolveCache(config.cache, importFn, rootStore, dir, pubsub, logger, additionalPackagePrefixes);
+ } = await resolveCache(
+ config.cache,
+ importFn,
+ rootStore,
+ dir,
+ pubsub,
+ logger,
+ additionalPackagePrefixes,
+ );
importCodes.add(cacheImportCode);
codes.add(cacheCode);
@@ -159,27 +175,33 @@ export async function processConfig(
codes.add(`const transforms: MeshTransform[] = [];`);
codes.add(`const additionalEnvelopPlugins: MeshPlugin[] = [];`);
- const [sources, transforms, additionalEnvelopPlugins, additionalTypeDefs, additionalResolvers, documents] =
- await Promise.all([
- Promise.all(
- config.sources.map>(async (source, sourceIndex) => {
- const handlerName = Object.keys(source.handler)[0].toString();
- const handlerConfig = source.handler[handlerName];
- const handlerVariableName = camelCase(`${source.name}_Handler`);
- const transformsVariableName = camelCase(`${source.name}_Transforms`);
- codes.add(`const ${transformsVariableName} = [];`);
- const [handler, transforms] = await Promise.all([
- await getPackage({
- name: handlerName,
- type: 'handler',
- importFn,
- cwd: dir,
- additionalPrefixes: additionalPackagePrefixes,
- }).then(({ resolved: HandlerCtor, moduleName }) => {
- if (options.generateCode) {
- const handlerImportName = pascalCase(handlerName + '_Handler');
- importCodes.add(`import ${handlerImportName} from ${JSON.stringify(moduleName)}`);
- codes.add(`const ${handlerVariableName} = new ${handlerImportName}({
+ const [
+ sources,
+ transforms,
+ additionalEnvelopPlugins,
+ additionalTypeDefs,
+ additionalResolvers,
+ documents,
+ ] = await Promise.all([
+ Promise.all(
+ config.sources.map>(async (source, sourceIndex) => {
+ const handlerName = Object.keys(source.handler)[0].toString();
+ const handlerConfig = source.handler[handlerName];
+ const handlerVariableName = camelCase(`${source.name}_Handler`);
+ const transformsVariableName = camelCase(`${source.name}_Transforms`);
+ codes.add(`const ${transformsVariableName} = [];`);
+ const [handler, transforms] = await Promise.all([
+ await getPackage({
+ name: handlerName,
+ type: 'handler',
+ importFn,
+ cwd: dir,
+ additionalPrefixes: additionalPackagePrefixes,
+ }).then(({ resolved: HandlerCtor, moduleName }) => {
+ if (options.generateCode) {
+ const handlerImportName = pascalCase(handlerName + '_Handler');
+ importCodes.add(`import ${handlerImportName} from ${JSON.stringify(moduleName)}`);
+ codes.add(`const ${handlerVariableName} = new ${handlerImportName}({
name: ${JSON.stringify(source.name)},
config: ${JSON.stringify(handlerConfig)},
baseDir,
@@ -189,23 +211,24 @@ export async function processConfig(
logger: logger.child(${JSON.stringify(source.name)}),
importFn,
});`);
- }
- return new HandlerCtor({
- name: source.name,
- config: handlerConfig,
- baseDir: dir,
- cache,
- pubsub,
- store: sourcesStore.child(source.name),
- logger: logger.child(source.name),
- importFn,
- });
- }),
- Promise.all(
- (source.transforms || []).map(async (t, transformIndex) => {
- const transformName = Object.keys(t)[0].toString();
- const transformConfig = t[transformName];
- const { resolved: TransformCtor, moduleName } = await getPackage({
+ }
+ return new HandlerCtor({
+ name: source.name,
+ config: handlerConfig,
+ baseDir: dir,
+ cache,
+ pubsub,
+ store: sourcesStore.child(source.name),
+ logger: logger.child(source.name),
+ importFn,
+ });
+ }),
+ Promise.all(
+ (source.transforms || []).map(async (t, transformIndex) => {
+ const transformName = Object.keys(t)[0].toString();
+ const transformConfig = t[transformName];
+ const { resolved: TransformCtor, moduleName } =
+ await getPackage({
name: transformName,
type: 'transform',
importFn,
@@ -213,10 +236,12 @@ export async function processConfig(
additionalPrefixes: additionalPackagePrefixes,
});
- if (options.generateCode) {
- const transformImportName = pascalCase(transformName + '_Transform');
- importCodes.add(`import ${transformImportName} from ${JSON.stringify(moduleName)};`);
- codes.add(`${transformsVariableName}[${transformIndex}] = new ${transformImportName}({
+ if (options.generateCode) {
+ const transformImportName = pascalCase(transformName + '_Transform');
+ importCodes.add(
+ `import ${transformImportName} from ${JSON.stringify(moduleName)};`,
+ );
+ codes.add(`${transformsVariableName}[${transformIndex}] = new ${transformImportName}({
apiName: ${JSON.stringify(source.name)},
config: ${JSON.stringify(transformConfig)},
baseDir,
@@ -225,53 +250,53 @@ export async function processConfig(
importFn,
logger,
});`);
- }
+ }
- return new TransformCtor({
- apiName: source.name,
- config: transformConfig,
- baseDir: dir,
- cache,
- pubsub,
- importFn,
- logger,
- });
- })
- ),
- ]);
+ return new TransformCtor({
+ apiName: source.name,
+ config: transformConfig,
+ baseDir: dir,
+ cache,
+ pubsub,
+ importFn,
+ logger,
+ });
+ }),
+ ),
+ ]);
- if (options.generateCode) {
- codes.add(`sources[${sourceIndex}] = {
+ if (options.generateCode) {
+ codes.add(`sources[${sourceIndex}] = {
name: '${source.name}',
handler: ${handlerVariableName},
transforms: ${transformsVariableName}
}`);
- }
+ }
- return {
- name: source.name,
- handler,
- transforms,
- };
- })
- ),
- Promise.all(
- config.transforms?.map(async (t, transformIndex) => {
- const transformName = Object.keys(t)[0].toString();
- const transformConfig = t[transformName];
- const { resolved: TransformLibrary, moduleName } = await getPackage({
- name: transformName,
- type: 'transform',
- importFn,
- cwd: dir,
- additionalPrefixes: additionalPackagePrefixes,
- });
+ return {
+ name: source.name,
+ handler,
+ transforms,
+ };
+ }),
+ ),
+ Promise.all(
+ config.transforms?.map(async (t, transformIndex) => {
+ const transformName = Object.keys(t)[0].toString();
+ const transformConfig = t[transformName];
+ const { resolved: TransformLibrary, moduleName } = await getPackage({
+ name: transformName,
+ type: 'transform',
+ importFn,
+ cwd: dir,
+ additionalPrefixes: additionalPackagePrefixes,
+ });
- if (options.generateCode) {
- const transformImportName = pascalCase(transformName + '_Transform');
- importCodes.add(`import ${transformImportName} from ${JSON.stringify(moduleName)};`);
+ if (options.generateCode) {
+ const transformImportName = pascalCase(transformName + '_Transform');
+ importCodes.add(`import ${transformImportName} from ${JSON.stringify(moduleName)};`);
- codes.add(`transforms[${transformIndex}] = new (${transformImportName} as any)({
+ codes.add(`transforms[${transformIndex}] = new (${transformImportName} as any)({
apiName: '',
config: ${JSON.stringify(transformConfig)},
baseDir,
@@ -280,50 +305,50 @@ export async function processConfig(
importFn,
logger,
})`);
+ }
+ return new TransformLibrary({
+ apiName: '',
+ config: transformConfig,
+ baseDir: dir,
+ cache,
+ pubsub,
+ importFn,
+ logger,
+ });
+ }) || [],
+ ),
+ Promise.all(
+ config.plugins?.map(async (p, pluginIndex) => {
+ const pluginName = Object.keys(p)[0].toString();
+ const pluginConfig: any = p[pluginName];
+ if (ENVELOP_CORE_PLUGINS_MAP[pluginName] != null) {
+ const { importName, moduleName, pluginFactory } = ENVELOP_CORE_PLUGINS_MAP[pluginName];
+ if (options.generateCode) {
+ importCodes.add(`import { ${importName} } from ${JSON.stringify(moduleName)};`);
+ codes.add(
+ `additionalEnvelopPlugins[${pluginIndex}] = await ${importName}(${JSON.stringify(
+ pluginConfig,
+ null,
+ 2,
+ )});`,
+ );
}
- return new TransformLibrary({
- apiName: '',
- config: transformConfig,
- baseDir: dir,
- cache,
- pubsub,
- importFn,
- logger,
- });
- }) || []
- ),
- Promise.all(
- config.plugins?.map(async (p, pluginIndex) => {
- const pluginName = Object.keys(p)[0].toString();
- const pluginConfig: any = p[pluginName];
- if (ENVELOP_CORE_PLUGINS_MAP[pluginName] != null) {
- const { importName, moduleName, pluginFactory } = ENVELOP_CORE_PLUGINS_MAP[pluginName];
- if (options.generateCode) {
- importCodes.add(`import { ${importName} } from ${JSON.stringify(moduleName)};`);
- codes.add(
- `additionalEnvelopPlugins[${pluginIndex}] = await ${importName}(${JSON.stringify(
- pluginConfig,
- null,
- 2
- )});`
- );
- }
- return pluginFactory(pluginConfig);
- }
- const { resolved: possiblePluginFactory, moduleName } = await getPackage({
- name: pluginName,
- type: 'plugin',
- importFn,
- cwd: dir,
- additionalPrefixes: [...additionalPackagePrefixes, '@envelop/', '@graphql-yoga/plugin-'],
- });
- let pluginFactory: MeshPluginFactory;
- if (typeof possiblePluginFactory === 'function') {
- pluginFactory = possiblePluginFactory;
- if (options.generateCode) {
- const importName = pascalCase('use_' + pluginName);
- importCodes.add(`import ${importName} from ${JSON.stringify(moduleName)};`);
- codes.add(`additionalEnvelopPlugins[${pluginIndex}] = await ${importName}({
+ return pluginFactory(pluginConfig);
+ }
+ const { resolved: possiblePluginFactory, moduleName } = await getPackage({
+ name: pluginName,
+ type: 'plugin',
+ importFn,
+ cwd: dir,
+ additionalPrefixes: [...additionalPackagePrefixes, '@envelop/', '@graphql-yoga/plugin-'],
+ });
+ let pluginFactory: MeshPluginFactory;
+ if (typeof possiblePluginFactory === 'function') {
+ pluginFactory = possiblePluginFactory;
+ if (options.generateCode) {
+ const importName = pascalCase('use_' + pluginName);
+ importCodes.add(`import ${importName} from ${JSON.stringify(moduleName)};`);
+ codes.add(`additionalEnvelopPlugins[${pluginIndex}] = await ${importName}({
...(${JSON.stringify(pluginConfig, null, 2)}),
logger: logger.child(${JSON.stringify(pluginName)}),
cache,
@@ -331,53 +356,56 @@ export async function processConfig(
baseDir,
importFn,
})`);
- }
- } else {
- Object.keys(possiblePluginFactory).forEach(importName => {
- if (importName.toString().startsWith('use') && typeof possiblePluginFactory[importName] === 'function') {
- pluginFactory = possiblePluginFactory[importName];
- importName = importName.toString();
- if (options.generateCode) {
- importCodes.add(`import { ${importName} } from ${JSON.stringify(moduleName)};`);
- codes.add(
- `additionalEnvelopPlugins[${pluginIndex}] = await ${importName}(${JSON.stringify(
- pluginConfig,
- null,
- 2
- )});`
- );
- }
- }
- });
}
- return pluginFactory({
- ...pluginConfig,
- logger: logger.child(pluginName),
- cache,
- pubsub,
- baseDir: dir,
- importFn,
+ } else {
+ Object.keys(possiblePluginFactory).forEach(importName => {
+ if (
+ importName.toString().startsWith('use') &&
+ typeof possiblePluginFactory[importName] === 'function'
+ ) {
+ pluginFactory = possiblePluginFactory[importName];
+ importName = importName.toString();
+ if (options.generateCode) {
+ importCodes.add(`import { ${importName} } from ${JSON.stringify(moduleName)};`);
+ codes.add(
+ `additionalEnvelopPlugins[${pluginIndex}] = await ${importName}(${JSON.stringify(
+ pluginConfig,
+ null,
+ 2,
+ )});`,
+ );
+ }
+ }
});
- }) || []
- ),
- resolveAdditionalTypeDefs(dir, config.additionalTypeDefs).then(additionalTypeDefs => {
- if (options.generateCode) {
- codes.add(
- `const additionalTypeDefs = [${(additionalTypeDefs || []).map(
- parsedTypeDefs => `parse(${JSON.stringify(print(parsedTypeDefs))}),`
- )}] as any[];`
- );
- if (additionalTypeDefs?.length) {
- importCodes.add(`import { parse } from 'graphql';`);
- }
}
- return additionalTypeDefs;
- }),
- options?.ignoreAdditionalResolvers
- ? []
- : resolveAdditionalResolvers(dir, config.additionalResolvers, importFn, pubsub),
- resolveDocuments(config.documents, dir),
- ]);
+ return pluginFactory({
+ ...pluginConfig,
+ logger: logger.child(pluginName),
+ cache,
+ pubsub,
+ baseDir: dir,
+ importFn,
+ });
+ }) || [],
+ ),
+ resolveAdditionalTypeDefs(dir, config.additionalTypeDefs).then(additionalTypeDefs => {
+ if (options.generateCode) {
+ codes.add(
+ `const additionalTypeDefs = [${(additionalTypeDefs || []).map(
+ parsedTypeDefs => `parse(${JSON.stringify(print(parsedTypeDefs))}),`,
+ )}] as any[];`,
+ );
+ if (additionalTypeDefs?.length) {
+ importCodes.add(`import { parse } from 'graphql';`);
+ }
+ }
+ return additionalTypeDefs;
+ }),
+ options?.ignoreAdditionalResolvers
+ ? []
+ : resolveAdditionalResolvers(dir, config.additionalResolvers, importFn, pubsub),
+ resolveDocuments(config.documents, dir),
+ ]);
if (options.generateCode) {
if (config.additionalResolvers?.length) {
@@ -386,11 +414,13 @@ export async function processConfig(
.map(additionalResolverDefinition => {
if (typeof additionalResolverDefinition === 'string') {
return `import(${JSON.stringify(
- pathModule.join('..', additionalResolverDefinition).split('\\').join('/')
+ pathModule.join('..', additionalResolverDefinition).split('\\').join('/'),
)})
.then(m => m.resolvers || m.default || m)`;
} else {
- importCodes.add(`import { resolveAdditionalResolversWithoutImport } from '@graphql-mesh/utils';`);
+ importCodes.add(
+ `import { resolveAdditionalResolversWithoutImport } from '@graphql-mesh/utils';`,
+ );
return `resolveAdditionalResolversWithoutImport(
${JSON.stringify(additionalResolverDefinition, null, 2)}
)`;
@@ -404,7 +434,8 @@ export async function processConfig(
}
if (additionalTypeDefs?.length) {
- const additionalResolversConfigFromTypeDefs = getAdditionalResolversFromTypeDefs(additionalTypeDefs);
+ const additionalResolversConfigFromTypeDefs =
+ getAdditionalResolversFromTypeDefs(additionalTypeDefs);
if (additionalResolversConfigFromTypeDefs?.length) {
const resolveToDirectiveDefinition = /* GraphQL */ `
scalar ResolveToSourceArgs
@@ -428,13 +459,15 @@ export async function processConfig(
dir,
additionalResolversConfigFromTypeDefs,
importFn,
- pubsub
+ pubsub,
);
additionalTypeDefs.unshift(parse(resolveToDirectiveDefinition));
additionalResolvers.push(...resolvedAdditionalResolvers);
if (options.generateCode && resolvedAdditionalResolvers.length) {
importCodes.add(`import { resolveAdditionalResolvers } from '@graphql-mesh/utils';`);
- codes.add(`additionalTypeDefs.unshift(parse(/* GraphQL */\`${resolveToDirectiveDefinition}\`))`);
+ codes.add(
+ `additionalTypeDefs.unshift(parse(/* GraphQL */\`${resolveToDirectiveDefinition}\`))`,
+ );
codes.add(`const additionalResolversFromTypeDefs = await resolveAdditionalResolvers(
baseDir,
${JSON.stringify(additionalResolversConfigFromTypeDefs)},
@@ -507,19 +540,21 @@ export async function processConfig(
if (config.additionalEnvelopPlugins) {
codes.add(
`const importedAdditionalEnvelopPlugins = await import(${JSON.stringify(
- pathModule.join('..', config.additionalEnvelopPlugins).split('\\').join('/')
- )}).then(m => m.default || m);`
+ pathModule.join('..', config.additionalEnvelopPlugins).split('\\').join('/'),
+ )}).then(m => m.default || m);`,
);
const importedAdditionalEnvelopPlugins = await importFn(
pathModule.isAbsolute(config.additionalEnvelopPlugins)
? config.additionalEnvelopPlugins
- : pathModule.join(dir, config.additionalEnvelopPlugins)
+ : pathModule.join(dir, config.additionalEnvelopPlugins),
);
if (typeof importedAdditionalEnvelopPlugins === 'function') {
const factoryResult = await importedAdditionalEnvelopPlugins(config);
if (Array.isArray(factoryResult)) {
if (options.generateCode) {
- codes.add(`additionalEnvelopPlugins.push(...(await importedAdditionalEnvelopPlugins()));`);
+ codes.add(
+ `additionalEnvelopPlugins.push(...(await importedAdditionalEnvelopPlugins()));`,
+ );
}
additionalEnvelopPlugins.push(...factoryResult);
} else {
@@ -548,7 +583,7 @@ export async function processConfig(
if (documents?.length) {
importCodes.add(`import { printWithCache } from '@graphql-mesh/utils';`);
const allDocumentNodes: DocumentNode = concatAST(
- documents.map(document => document.document || parseWithCache(document.rawSDL))
+ documents.map(document => document.document || parseWithCache(document.rawSDL)),
);
visit(allDocumentNodes, {
OperationDefinition(node) {
@@ -578,7 +613,7 @@ export async function processConfig(
return printWithCache(${documentVarName});
},
location: '${documentVarName}.graphql'
- }`
+ }`,
)
.join(',')}
];
diff --git a/packages/config/src/utils.ts b/packages/config/src/utils.ts
index 6d4afef63925f..23908d68bff49 100644
--- a/packages/config/src/utils.ts
+++ b/packages/config/src/utils.ts
@@ -1,4 +1,11 @@
-import { KeyValueCache, YamlConfig, ImportFn, MeshPubSub, Logger, MeshFetch } from '@graphql-mesh/types';
+import {
+ KeyValueCache,
+ YamlConfig,
+ ImportFn,
+ MeshPubSub,
+ Logger,
+ MeshFetch,
+} from '@graphql-mesh/types';
import { path } from '@graphql-mesh/cross-helpers';
import { printSchemaWithDirectives, Source } from '@graphql-tools/utils';
import { paramCase } from 'param-case';
@@ -32,7 +39,12 @@ export async function getPackage({
const casedName = paramCase(name);
const casedType = paramCase(type);
const prefixes = ['@graphql-mesh/', ...additionalPrefixes];
- const initialPossibleNames = [casedName, `${casedName}-${casedType}`, `${casedType}-${casedName}`, casedType];
+ const initialPossibleNames = [
+ casedName,
+ `${casedName}-${casedType}`,
+ `${casedType}-${casedName}`,
+ casedType,
+ ];
const possibleNames: string[] = [];
for (const prefix of prefixes) {
for (const possibleName of initialPossibleNames) {
@@ -62,7 +74,9 @@ export async function getPackage({
!error.message.includes(`Cannot find package '${moduleName}'`) &&
!error.message.includes(`Could not locate module`)
) {
- throw new Error(`Unable to load ${type} matching ${name} while resolving ${moduleName}: ${error.stack}`);
+ throw new Error(
+ `Unable to load ${type} matching ${name} while resolving ${moduleName}: ${error.stack}`,
+ );
}
}
}
@@ -77,7 +91,9 @@ export async function resolveAdditionalTypeDefs(baseDir: string, additionalTypeD
loaders: [new CodeFileLoader(), new GraphQLFileLoader()],
});
return sources.map(
- source => source.document || parseWithCache(source.rawSDL || printSchemaWithDirectives(source.schema))
+ source =>
+ source.document ||
+ parseWithCache(source.rawSDL || printSchemaWithDirectives(source.schema)),
);
}
return undefined;
@@ -135,7 +151,7 @@ export async function resolveCache(
cwd: string,
pubsub: MeshPubSub,
logger: Logger,
- additionalPackagePrefixes: string[]
+ additionalPackagePrefixes: string[],
): Promise<{
cache: KeyValueCache;
importCode: string;
@@ -180,7 +196,7 @@ export async function resolvePubSub(
pubsubYamlConfig: YamlConfig.Config['pubsub'],
importFn: ImportFn,
cwd: string,
- additionalPackagePrefixes: string[]
+ additionalPackagePrefixes: string[],
): Promise<{
importCode: string;
code: string;
@@ -230,7 +246,7 @@ export async function resolvePubSub(
export async function resolveDocuments(
documentsConfig: YamlConfig.Config['documents'],
- cwd: string
+ cwd: string,
): Promise {
if (!documentsConfig) {
return [];
@@ -247,7 +263,7 @@ export async function resolveLogger(
importFn: ImportFn,
cwd: string,
additionalPackagePrefixes: string[],
- initialLoggerPrefix = '🕸️ Mesh'
+ initialLoggerPrefix = '🕸️ Mesh',
): Promise<{
importCode: string;
code: string;
diff --git a/packages/cross-helpers/CHANGELOG.md b/packages/cross-helpers/CHANGELOG.md
index 6ed08f51bbecf..f5df3288b060d 100644
--- a/packages/cross-helpers/CHANGELOG.md
+++ b/packages/cross-helpers/CHANGELOG.md
@@ -4,95 +4,145 @@
### Patch Changes
-- [#4790](https://github.com/Urigo/graphql-mesh/pull/4790) [`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4790](https://github.com/Urigo/graphql-mesh/pull/4790)
+ [`8c7d96cff`](https://github.com/Urigo/graphql-mesh/commit/8c7d96cff868095216520bafebe989ec94a9df65)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@9.1.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.0) (from `9.0.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@9.1.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.0)
+ (from `9.0.1`, in `dependencies`)
-- [#4809](https://github.com/Urigo/graphql-mesh/pull/4809) [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@9.1.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.1) (from `9.1.0`, in `dependencies`)
+- [#4809](https://github.com/Urigo/graphql-mesh/pull/4809)
+ [`db95881b5`](https://github.com/Urigo/graphql-mesh/commit/db95881b530053064425f476ccac7d552d44af33)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@9.1.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.1.1)
+ (from `9.1.0`, in `dependencies`)
## 0.2.9
### Patch Changes
-- [#4775](https://github.com/Urigo/graphql-mesh/pull/4775) [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@9.0.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.0.1) (from `8.13.1`, in `dependencies`)
+- [#4775](https://github.com/Urigo/graphql-mesh/pull/4775)
+ [`a764fe0d3`](https://github.com/Urigo/graphql-mesh/commit/a764fe0d36928cd830e79942f8ab57cd70d2602a)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@9.0.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/9.0.1)
+ (from `8.13.1`, in `dependencies`)
## 0.2.8
### Patch Changes
-- [#4765](https://github.com/Urigo/graphql-mesh/pull/4765) [`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.13.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.1) (from `8.13.0`, in `dependencies`)
+- [#4765](https://github.com/Urigo/graphql-mesh/pull/4765)
+ [`f26714af8`](https://github.com/Urigo/graphql-mesh/commit/f26714af8afff2eb5384f7294f5d8856eb5cf20a)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@8.13.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.1)
+ (from `8.13.0`, in `dependencies`)
## 0.2.7
### Patch Changes
-- [#4745](https://github.com/Urigo/graphql-mesh/pull/4745) [`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.13.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.0) (from `8.12.0`, in `dependencies`)
+- [#4745](https://github.com/Urigo/graphql-mesh/pull/4745)
+ [`bfedc23d9`](https://github.com/Urigo/graphql-mesh/commit/bfedc23d978089d15d9b67320fde0e6f5ac762fd)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+ - Updated dependency
+ [`@graphql-tools/utils@8.13.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.13.0)
+ (from `8.12.0`, in `dependencies`)
## 0.2.6
### Patch Changes
-- [#4439](https://github.com/Urigo/graphql-mesh/pull/4439) [`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2) Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
+- [#4439](https://github.com/Urigo/graphql-mesh/pull/4439)
+ [`78599180d`](https://github.com/Urigo/graphql-mesh/commit/78599180d76f71e6d23114a0115e6338785a44d2)
+ Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0) (from `8.10.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0)
+ (from `8.10.1`, in `dependencies`)
## 0.2.5
### Patch Changes
-- [#4466](https://github.com/Urigo/graphql-mesh/pull/4466) [`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4466](https://github.com/Urigo/graphql-mesh/pull/4466)
+ [`6f52af1c2`](https://github.com/Urigo/graphql-mesh/commit/6f52af1c2d6bf0a9de555a4d535b459ff2d8987f)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0) (from `8.11.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.12.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.12.0)
+ (from `8.11.0`, in `dependencies`)
## 0.2.4
### Patch Changes
-- [#4443](https://github.com/Urigo/graphql-mesh/pull/4443) [`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4443](https://github.com/Urigo/graphql-mesh/pull/4443)
+ [`9dac0d835`](https://github.com/Urigo/graphql-mesh/commit/9dac0d8355148d86d75bceb4c4983960e8063c53)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.11.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.11.0) (from `8.10.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.11.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.11.0)
+ (from `8.10.1`, in `dependencies`)
## 0.2.3
### Patch Changes
-- [#4380](https://github.com/Urigo/graphql-mesh/pull/4380) [`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd) Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
+- [#4380](https://github.com/Urigo/graphql-mesh/pull/4380)
+ [`e69462cac`](https://github.com/Urigo/graphql-mesh/commit/e69462cac667c4ffb2d9ba35adeef15264d263fd)
+ Thanks [@gilgardosh](https://github.com/gilgardosh)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1) (from `8.10.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1)
+ (from `8.10.0`, in `dependencies`)
-- [#4389](https://github.com/Urigo/graphql-mesh/pull/4389) [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4389](https://github.com/Urigo/graphql-mesh/pull/4389)
+ [`12ae4469a`](https://github.com/Urigo/graphql-mesh/commit/12ae4469aa89d613bfd36a87579adc1ae62c4a1f)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1) (from `8.10.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.1)
+ (from `8.10.0`, in `dependencies`)
## 0.2.2
### Patch Changes
-- [#4275](https://github.com/Urigo/graphql-mesh/pull/4275) [`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4275](https://github.com/Urigo/graphql-mesh/pull/4275)
+ [`a2e59dfdd`](https://github.com/Urigo/graphql-mesh/commit/a2e59dfdd70b8a7bc0e9d658ff1a53029757eaa2)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.10.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.0) (was `8.9.1`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.10.0` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.10.0)
+ (was `8.9.1`, in `dependencies`)
## 0.2.1
### Patch Changes
-- [#4263](https://github.com/Urigo/graphql-mesh/pull/4263) [`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73) Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
+- [#4263](https://github.com/Urigo/graphql-mesh/pull/4263)
+ [`db10974ea`](https://github.com/Urigo/graphql-mesh/commit/db10974eaa422967b3ce0ff0101ae97bca3ebf73)
+ Thanks [@renovate](https://github.com/apps/renovate)! - dependencies updates:
- - Updated dependency [`@graphql-tools/utils@8.9.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.9.1) (was `8.9.0`, in `dependencies`)
+ - Updated dependency
+ [`@graphql-tools/utils@8.9.1` ↗︎](https://www.npmjs.com/package/@graphql-tools/utils/v/8.9.1)
+ (was `8.9.0`, in `dependencies`)
## 0.2.0
### Minor Changes
-- 0401c7617: **Improvements on string interpolation ({env.sth} or {context.headers.sth}) for different environments**
+- 0401c7617: **Improvements on string interpolation ({env.sth} or {context.headers.sth}) for
+ different environments**
As we mention in most of our docs, we usually expect a key-value `header` object in the context.
- But Fetch-like environments don't have this kind of object but instead `Headers` object which is a kind `Map`.
- Now Mesh can detect this and automatically convert it to the key-value object especially for Yoga users.
+ But Fetch-like environments don't have this kind of object but instead `Headers` object which is a
+ kind `Map`. Now Mesh can detect this and automatically convert it to the key-value object
+ especially for Yoga users.
Also Mesh now handles `env` in a better way for non-Node environments;
diff --git a/packages/cross-helpers/browser.js b/packages/cross-helpers/browser.js
index 6b8b5a929ea05..26234f784a195 100644
--- a/packages/cross-helpers/browser.js
+++ b/packages/cross-helpers/browser.js
@@ -26,7 +26,7 @@ const processObj =
}
return globalThis[key];
},
- }
+ },
);
}
},
diff --git a/packages/cross-helpers/react-native.js b/packages/cross-helpers/react-native.js
index 914ff3f4ef29e..82e94a2278cdc 100644
--- a/packages/cross-helpers/react-native.js
+++ b/packages/cross-helpers/react-native.js
@@ -1,6 +1,7 @@
module.exports.fs = require('react-native-fs');
module.exports.path = require('react-native-path');
-module.exports.path.join = (...args) => module.exports.path.normalize(args.filter(x => !!x).join('/'));
+module.exports.path.join = (...args) =>
+ module.exports.path.normalize(args.filter(x => !!x).join('/'));
Promise.allSettled =
Promise.allSettled ||
@@ -15,8 +16,8 @@ Promise.allSettled =
.catch(reason => ({
status: 'rejected',
reason,
- }))
- )
+ })),
+ ),
));
module.exports.process =
diff --git a/packages/handlers/graphql/src/index.ts b/packages/handlers/graphql/src/index.ts
index dc47408d2151f..841fb2bc1e76b 100644
--- a/packages/handlers/graphql/src/index.ts
+++ b/packages/handlers/graphql/src/index.ts
@@ -60,11 +60,21 @@ export default class GraphQLHandler implements MeshHandler {
private logger: Logger;
private urlLoader = new UrlLoader();
- constructor({ name, config, baseDir, store, importFn, logger }: MeshHandlerOptions) {
+ constructor({
+ name,
+ config,
+ baseDir,
+ store,
+ importFn,
+ logger,
+ }: MeshHandlerOptions) {
this.name = name;
this.config = config;
this.baseDir = baseDir;
- this.nonExecutableSchema = store.proxy('introspectionSchema', PredefinedProxyOptions.GraphQLSchemaWithDiffing);
+ this.nonExecutableSchema = store.proxy(
+ 'introspectionSchema',
+ PredefinedProxyOptions.GraphQLSchemaWithDiffing,
+ );
this.importFn = importFn;
this.logger = logger;
}
@@ -85,7 +95,7 @@ export default class GraphQLHandler implements MeshHandler {
}
async getExecutorForHTTPSourceConfig(
- httpSourceConfig: YamlConfig.GraphQLHandlerHTTPConfiguration
+ httpSourceConfig: YamlConfig.GraphQLHandlerHTTPConfiguration,
): Promise {
const { endpoint, operationHeaders = {} } = httpSourceConfig;
@@ -116,14 +126,16 @@ export default class GraphQLHandler implements MeshHandler {
}
async getNonExecutableSchemaForHTTPSource(
- httpSourceConfig: YamlConfig.GraphQLHandlerHTTPConfiguration
+ httpSourceConfig: YamlConfig.GraphQLHandlerHTTPConfiguration,
): Promise {
this.interpolationStringSet.add(httpSourceConfig.endpoint);
Object.keys(httpSourceConfig.schemaHeaders || {}).forEach(headerName => {
this.interpolationStringSet.add(headerName.toString());
});
- const schemaHeadersFactory = getInterpolatedHeadersFactory(httpSourceConfig.schemaHeaders || {});
+ const schemaHeadersFactory = getInterpolatedHeadersFactory(
+ httpSourceConfig.schemaHeaders || {},
+ );
if (httpSourceConfig.source) {
const headers = schemaHeadersFactory({
env: process.env,
@@ -137,7 +149,7 @@ export default class GraphQLHandler implements MeshHandler {
fetch: this.fetchFn,
logger: this.logger,
headers,
- }
+ },
);
if (typeof sdlOrIntrospection === 'string') {
return buildSchema(sdlOrIntrospection);
@@ -188,10 +200,9 @@ export default class GraphQLHandler implements MeshHandler {
};
} else {
// Loaders logic should be here somehow
- const schemaOrStringOrDocumentNode = await loadFromModuleExportExpression(
- schemaConfig,
- { cwd: this.baseDir, defaultExportName: 'schema', importFn: this.importFn }
- );
+ const schemaOrStringOrDocumentNode = await loadFromModuleExportExpression<
+ GraphQLSchema | string | DocumentNode
+ >(schemaConfig, { cwd: this.baseDir, defaultExportName: 'schema', importFn: this.importFn });
let schema: GraphQLSchema;
if (schemaOrStringOrDocumentNode instanceof GraphQLSchema) {
schema = schemaOrStringOrDocumentNode;
@@ -205,8 +216,8 @@ export default class GraphQLHandler implements MeshHandler {
} else {
throw new Error(
`Provided file '${schemaConfig} exports an unknown type: ${util.inspect(
- schemaOrStringOrDocumentNode
- )}': expected GraphQLSchema, SDL or DocumentNode.`
+ schemaOrStringOrDocumentNode,
+ )}': expected GraphQLSchema, SDL or DocumentNode.`,
);
}
const { contextVariables } = this.getArgsAndContextVariables();
@@ -263,7 +274,10 @@ export default class GraphQLHandler implements MeshHandler {
executorPromises.push(this.getExecutorForHTTPSourceConfig(httpSourceConfig));
}
- const [schema, ...executors] = await Promise.all([Promise.race(schemaPromises), ...executorPromises]);
+ const [schema, ...executors] = await Promise.all([
+ Promise.race(schemaPromises),
+ ...executorPromises,
+ ]);
const executor = this.getRaceExecutor(executors);
@@ -299,9 +313,13 @@ export default class GraphQLHandler implements MeshHandler {
const executors = await Promise.all(executorPromises);
const parsedSelectionSet = parseSelectionSet(this.config.strategyConfig.selectionSet);
const valuePath = this.config.strategyConfig.value;
- const highestValueExecutor = async function highestValueExecutor(executionRequest: ExecutionRequest) {
+ const highestValueExecutor = async function highestValueExecutor(
+ executionRequest: ExecutionRequest,
+ ) {
const operationAST = getOperationASTFromRequest(executionRequest);
- (operationAST.selectionSet.selections as SelectionNode[]).push(...parsedSelectionSet.selections);
+ (operationAST.selectionSet.selections as SelectionNode[]).push(
+ ...parsedSelectionSet.selections,
+ );
const results = await Promise.all(executors.map(executor => executor(executionRequest)));
let highestValue = -Infinity;
let resultWithHighestResult = results[0];
@@ -367,12 +385,16 @@ export default class GraphQLHandler implements MeshHandler {
]);
if (schemaResult.status === 'rejected') {
throw new Error(
- `Failed to fetch introspection from ${this.config.endpoint}: ${util.inspect(schemaResult.reason)}`
+ `Failed to fetch introspection from ${this.config.endpoint}: ${util.inspect(
+ schemaResult.reason,
+ )}`,
);
}
if (executorResult.status === 'rejected') {
throw new Error(
- `Failed to create executor for ${this.config.endpoint}: ${util.inspect(executorResult.reason)}`
+ `Failed to create executor for ${this.config.endpoint}: ${util.inspect(
+ executorResult.reason,
+ )}`,
);
}
const { contextVariables } = this.getArgsAndContextVariables();
diff --git a/packages/handlers/graphql/test/handler.spec.ts b/packages/handlers/graphql/test/handler.spec.ts
index fec5d392eec6d..468988b0f73b5 100644
--- a/packages/handlers/graphql/test/handler.spec.ts
+++ b/packages/handlers/graphql/test/handler.spec.ts
@@ -38,7 +38,9 @@ describe('graphql', () => {
const { schema: schemaFromHandler } = await handler.getMeshSource({
fetchFn,
});
- expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(introspectionFromSchema(schemaFromFile));
+ expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(
+ introspectionFromSchema(schemaFromFile),
+ );
});
it('handle code files exports GraphQLSchema correctly', async () => {
const schemaFilePath = './fixtures/schema.js';
@@ -63,7 +65,9 @@ describe('graphql', () => {
const { schema: schemaFromHandler } = await handler.getMeshSource({
fetchFn,
});
- expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(introspectionFromSchema(schemaFromFile));
+ expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(
+ introspectionFromSchema(schemaFromFile),
+ );
});
it('handle code files exports DocumentNode correctly', async () => {
const schemaFilePath = './fixtures/schema-document.js';
@@ -89,7 +93,9 @@ describe('graphql', () => {
const { schema: schemaFromHandler } = await handler.getMeshSource({
fetchFn,
});
- expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(introspectionFromSchema(schemaFromFile));
+ expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(
+ introspectionFromSchema(schemaFromFile),
+ );
});
it('handle code files exports string correctly', async () => {
const schemaFilePath = './fixtures/schema-str.js';
@@ -115,6 +121,8 @@ describe('graphql', () => {
const { schema: schemaFromHandler } = await handler.getMeshSource({
fetchFn,
});
- expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(introspectionFromSchema(schemaFromFile));
+ expect(introspectionFromSchema(schemaFromHandler)).toStrictEqual(
+ introspectionFromSchema(schemaFromFile),
+ );
});
});
diff --git a/packages/handlers/json-schema/src/index.ts b/packages/handlers/json-schema/src/index.ts
index 70646816ef7af..09f4054cbaaa9 100644
--- a/packages/handlers/json-schema/src/index.ts
+++ b/packages/handlers/json-schema/src/index.ts
@@ -10,7 +10,11 @@ import {
MeshSource,
MeshFetch,
} from '@graphql-mesh/types';
-import { JSONSchemaLoaderBundle, createBundle, getGraphQLSchemaFromBundle } from '@omnigraph/json-schema';
+import {
+ JSONSchemaLoaderBundle,
+ createBundle,
+ getGraphQLSchemaFromBundle,
+} from '@omnigraph/json-schema';
import { loadFromModuleExportExpression, readFileOrUrl } from '@graphql-mesh/utils';
import { getInterpolatedHeadersFactory } from '@graphql-mesh/string-interpolation';
import { process } from '@graphql-mesh/cross-helpers';
@@ -38,7 +42,10 @@ export default class JsonSchemaHandler implements MeshHandler {
this.config = config;
this.baseDir = baseDir;
this.importFn = importFn;
- this.bundleStoreProxy = store.proxy('jsonSchemaBundle', PredefinedProxyOptions.JsonWithoutValidation);
+ this.bundleStoreProxy = store.proxy(
+ 'jsonSchemaBundle',
+ PredefinedProxyOptions.JsonWithoutValidation,
+ );
this.pubsub = pubsub;
this.logger = logger;
}
@@ -66,7 +73,8 @@ export default class JsonSchemaHandler implements MeshHandler {
cwd: this.baseDir,
fetch: this.fetchFn,
logger: this.logger,
- operationHeaders: typeof config.operationHeaders === 'string' ? {} : config.operationHeaders,
+ operationHeaders:
+ typeof config.operationHeaders === 'string' ? {} : config.operationHeaders,
});
});
}
@@ -77,11 +85,14 @@ export default class JsonSchemaHandler implements MeshHandler {
const bundle = await this.getDereferencedBundle();
const operationHeadersConfig =
typeof this.config.operationHeaders === 'string'
- ? await loadFromModuleExportExpression>(this.config.operationHeaders, {
- cwd: this.baseDir,
- importFn: this.importFn,
- defaultExportName: 'default',
- })
+ ? await loadFromModuleExportExpression>(
+ this.config.operationHeaders,
+ {
+ cwd: this.baseDir,
+ importFn: this.importFn,
+ defaultExportName: 'default',
+ },
+ )
: this.config.operationHeaders;
const schema = await getGraphQLSchemaFromBundle(bundle, {
cwd: this.baseDir,
diff --git a/packages/handlers/mongoose/src/index.ts b/packages/handlers/mongoose/src/index.ts
index 07c8280e6cf32..2905e83ed2ed8 100644
--- a/packages/handlers/mongoose/src/index.ts
+++ b/packages/handlers/mongoose/src/index.ts
@@ -1,6 +1,13 @@
import { composeWithMongoose, composeWithMongooseDiscriminators } from 'graphql-compose-mongoose';
import { SchemaComposer } from 'graphql-compose';
-import { MeshHandlerOptions, MeshPubSub, MeshHandler, MeshSource, YamlConfig, ImportFn } from '@graphql-mesh/types';
+import {
+ MeshHandlerOptions,
+ MeshPubSub,
+ MeshHandler,
+ MeshSource,
+ YamlConfig,
+ ImportFn,
+} from '@graphql-mesh/types';
import { connect, disconnect, ConnectOptions, Document, Model } from 'mongoose';
import { loadFromModuleExportExpression } from '@graphql-mesh/utils';
import { specifiedDirectives } from 'graphql';
@@ -34,7 +41,12 @@ export default class MongooseHandler implements MeshHandler {
private pubsub: MeshPubSub;
private importFn: ImportFn;
- constructor({ config, baseDir, pubsub, importFn }: MeshHandlerOptions) {
+ constructor({
+ config,
+ baseDir,
+ pubsub,
+ importFn,
+ }: MeshHandlerOptions) {
this.config = config;
this.baseDir = baseDir;
this.pubsub = pubsub;
@@ -57,11 +69,14 @@ export default class MongooseHandler implements MeshHandler {
await Promise.all([
Promise.all(
this.config.models?.map(async modelConfig => {
- const model = await loadFromModuleExportExpression>>(modelConfig.path, {
- defaultExportName: modelConfig.name,
- cwd: this.baseDir,
- importFn: this.importFn,
- });
+ const model = await loadFromModuleExportExpression>>(
+ modelConfig.path,
+ {
+ defaultExportName: modelConfig.name,
+ cwd: this.baseDir,
+ importFn: this.importFn,
+ },
+ );
if (!model) {
throw new Error(`Model ${modelConfig.name} cannot be imported ${modelConfig.path}!`);
}
@@ -71,15 +86,16 @@ export default class MongooseHandler implements MeshHandler {
modelQueryOperations.map(async queryOperation =>
schemaComposer.Query.addFields({
[`${modelConfig.name}_${queryOperation}`]: modelTC.getResolver(queryOperation),
- })
- )
+ }),
+ ),
),
Promise.all(
modelMutationOperations.map(async mutationOperation =>
schemaComposer.Mutation.addFields({
- [`${modelConfig.name}_${mutationOperation}`]: modelTC.getResolver(mutationOperation),
- })
- )
+ [`${modelConfig.name}_${mutationOperation}`]:
+ modelTC.getResolver(mutationOperation),
+ }),
+ ),
),
]);
const typeName = modelTC.getTypeName();
@@ -89,30 +105,38 @@ export default class MongooseHandler implements MeshHandler {
argsFromKeys: ids => ({ ids }),
fieldName: `${typeName}_dataLoaderMany`,
};
- }) || []
+ }) || [],
),
Promise.all(
this.config.discriminators?.map(async discriminatorConfig => {
- const discriminator = await loadFromModuleExportExpression(discriminatorConfig.path, {
- defaultExportName: discriminatorConfig.name,
- cwd: this.baseDir,
- importFn: this.importFn,
- });
- const discriminatorTC = composeWithMongooseDiscriminators(discriminator, discriminatorConfig.options as any);
+ const discriminator = await loadFromModuleExportExpression(
+ discriminatorConfig.path,
+ {
+ defaultExportName: discriminatorConfig.name,
+ cwd: this.baseDir,
+ importFn: this.importFn,
+ },
+ );
+ const discriminatorTC = composeWithMongooseDiscriminators(
+ discriminator,
+ discriminatorConfig.options as any,
+ );
await Promise.all([
Promise.all(
modelQueryOperations.map(async queryOperation =>
schemaComposer.Query.addFields({
- [`${discriminatorConfig.name}_${queryOperation}`]: discriminatorTC.getResolver(queryOperation),
- })
- )
+ [`${discriminatorConfig.name}_${queryOperation}`]:
+ discriminatorTC.getResolver(queryOperation),
+ }),
+ ),
),
Promise.all(
modelMutationOperations.map(async mutationOperation =>
schemaComposer.Mutation.addFields({
- [`${discriminatorConfig.name}_${mutationOperation}`]: discriminatorTC.getResolver(mutationOperation),
- })
- )
+ [`${discriminatorConfig.name}_${mutationOperation}`]:
+ discriminatorTC.getResolver(mutationOperation),
+ }),
+ ),
),
]);
const typeName = discriminatorTC.getTypeName();
@@ -122,7 +146,7 @@ export default class MongooseHandler implements MeshHandler {
argsFromKeys: ids => ({ ids }),
fieldName: `${typeName}_dataLoaderMany`,
};
- }) || []
+ }) || [],
),
]);
diff --git a/packages/handlers/mysql/src/index.ts b/packages/handlers/mysql/src/index.ts
index 0e3a1191e8a5b..ccf6d4a175228 100644
--- a/packages/handlers/mysql/src/index.ts
+++ b/packages/handlers/mysql/src/index.ts
@@ -1,4 +1,11 @@
-import { MeshHandlerOptions, MeshPubSub, MeshHandler, MeshSource, YamlConfig, ImportFn } from '@graphql-mesh/types';
+import {
+ MeshHandlerOptions,
+ MeshPubSub,
+ MeshHandler,
+ MeshSource,
+ YamlConfig,
+ ImportFn,
+} from '@graphql-mesh/types';
import { SchemaComposer, EnumTypeComposerValueConfigDefinition } from 'graphql-compose';
import { TableForeign, createPool, Pool } from 'mysql';
import { upgrade, introspection } from 'mysql-utilities';
@@ -122,7 +129,7 @@ async function getPromisifiedConnection(pool: Pool) {
function getFieldsFromResolveInfo(info: GraphQLResolveInfo) {
const fieldMap: Record = graphqlFields(info);
return Object.keys(fieldMap).filter(
- fieldName => Object.keys(fieldMap[fieldName]).length === 0 && fieldName !== '__typename'
+ fieldName => Object.keys(fieldMap[fieldName]).length === 0 && fieldName !== '__typename',
);
}
@@ -133,7 +140,15 @@ export default class MySQLHandler implements MeshHandler {
private store: MeshStore;
private importFn: ImportFn;
- constructor({ name, config, baseDir, pubsub, store, importFn, logger }: MeshHandlerOptions) {
+ constructor({
+ name,
+ config,
+ baseDir,
+ pubsub,
+ store,
+ importFn,
+ logger,
+ }: MeshHandlerOptions) {
this.config = config;
this.baseDir = baseDir;
this.pubsub = pubsub;
@@ -147,11 +162,16 @@ export default class MySQLHandler implements MeshHandler {
get: (_, methodName) => {
if (methodName === 'release') {
return () =>
- promisifiedConnection$?.then(promisifiedConnection => promisifiedConnection?.connection.release());
+ promisifiedConnection$?.then(promisifiedConnection =>
+ promisifiedConnection?.connection.release(),
+ );
}
return async (...args: any[]) => {
const cacheKey = [methodName, ...args].join('_');
- const cacheProxy = this.store.proxy(cacheKey, PredefinedProxyOptions.JsonWithoutValidation);
+ const cacheProxy = this.store.proxy(
+ cacheKey,
+ PredefinedProxyOptions.JsonWithoutValidation,
+ );
return cacheProxy.getWithSet(async () => {
promisifiedConnection$ = promisifiedConnection$ || getPromisifiedConnection(pool);
const promisifiedConnection = await promisifiedConnection$;
@@ -178,12 +198,19 @@ export default class MySQLHandler implements MeshHandler {
bigNumberStrings: true,
trace: !!process.env.DEBUG,
debug: !!process.env.DEBUG,
- host: this.config.host && stringInterpolator.parse(this.config.host, { env: process.env }),
+ host:
+ this.config.host && stringInterpolator.parse(this.config.host, { env: process.env }),
port:
- this.config.port && parseInt(stringInterpolator.parse(this.config.port.toString(), { env: process.env })),
- user: this.config.user && stringInterpolator.parse(this.config.user, { env: process.env }),
- password: this.config.password && stringInterpolator.parse(this.config.password, { env: process.env }),
- database: this.config.database && stringInterpolator.parse(this.config.database, { env: process.env }),
+ this.config.port &&
+ parseInt(stringInterpolator.parse(this.config.port.toString(), { env: process.env })),
+ user:
+ this.config.user && stringInterpolator.parse(this.config.user, { env: process.env }),
+ password:
+ this.config.password &&
+ stringInterpolator.parse(this.config.password, { env: process.env }),
+ database:
+ this.config.database &&
+ stringInterpolator.parse(this.config.database, { env: process.env }),
...this.config,
});
@@ -213,7 +240,9 @@ export default class MySQLHandler implements MeshHandler {
},
},
});
- const tables = await introspectionConnection.getDatabaseTables(pool.config.connectionConfig.database);
+ const tables = await introspectionConnection.getDatabaseTables(
+ pool.config.connectionConfig.database,
+ );
const tableNames = this.config.tables || Object.keys(tables);
const typeMergingOptions: MeshSource['merge'] = {};
await Promise.all(
@@ -260,7 +289,8 @@ export default class MySQLHandler implements MeshHandler {
const primaryKeys = new Set();
const fields = await introspectionConnection.getTableFields(tableName);
const fieldNames =
- this.config.tableFields?.find(({ table }) => table === tableName)?.fields || Object.keys(fields);
+ this.config.tableFields?.find(({ table }) => table === tableName)?.fields ||
+ Object.keys(fields);
await Promise.all(
fieldNames.map(async fieldName => {
const tableField = fields[fieldName];
@@ -290,7 +320,9 @@ export default class MySQLHandler implements MeshHandler {
type = enumTypeName;
}
if (!type) {
- console.warn(`${realTypeName} couldn't be mapped to a type. It will be mapped to JSON as a fallback.`);
+ console.warn(
+ `${realTypeName} couldn't be mapped to a type. It will be mapped to JSON as a fallback.`,
+ );
type = 'JSON';
}
if (tableField.Null.toLowerCase() === 'no') {
@@ -326,7 +358,7 @@ export default class MySQLHandler implements MeshHandler {
description: tableField.Comment || undefined,
},
});
- })
+ }),
);
const tableForeigns = await introspectionConnection.getTableForeigns(tableName);
const tableForeignNames = Object.keys(tableForeigns);
@@ -342,7 +374,9 @@ export default class MySQLHandler implements MeshHandler {
const foreignObjectTypeName = sanitizeNameForGraphQL(foreignTableName);
const foreignWhereInputName = sanitizeNameForGraphQL(foreignTableName + '_WhereInput');
- const foreignOrderByInputName = sanitizeNameForGraphQL(foreignTableName + '_OrderByInput');
+ const foreignOrderByInputName = sanitizeNameForGraphQL(
+ foreignTableName + '_OrderByInput',
+ );
tableTC.addFields({
[foreignTableName]: {
type: '[' + foreignObjectTypeName + ']',
@@ -370,7 +404,13 @@ export default class MySQLHandler implements MeshHandler {
const limit: number[] = [args.limit, args.offset].filter(Boolean);
const fields = getFieldsFromResolveInfo(info);
if (limit.length) {
- return mysqlConnection.selectLimit(foreignTableName, fields, limit, where, args?.orderBy);
+ return mysqlConnection.selectLimit(
+ foreignTableName,
+ fields,
+ limit,
+ where,
+ args?.orderBy,
+ );
} else {
return mysqlConnection.select(foreignTableName, fields, where, args?.orderBy);
}
@@ -411,8 +451,9 @@ export default class MySQLHandler implements MeshHandler {
if (Object.keys(subFieldMap).length === 0) {
fields.push(fieldName);
} else {
- const tableForeign = schemaComposer.getOTC(objectTypeName).getField(fieldName)
- .extensions as TableForeign;
+ const tableForeign = schemaComposer
+ .getOTC(objectTypeName)
+ .getField(fieldName).extensions as TableForeign;
fields.push(tableForeign.COLUMN_NAME);
}
}
@@ -420,14 +461,20 @@ export default class MySQLHandler implements MeshHandler {
// Generate limit statement
const limit = [args.limit, args.offset].filter(Boolean);
if (limit.length) {
- return mysqlConnection.selectLimit(tableName, fields, limit, where, args?.orderBy);
+ return mysqlConnection.selectLimit(
+ tableName,
+ fields,
+ limit,
+ where,
+ args?.orderBy,
+ );
} else {
return mysqlConnection.select(tableName, fields, where, args?.orderBy);
}
},
},
});
- })
+ }),
);
typeMergingOptions[objectTypeName] = {
selectionSet: `{ ${[...primaryKeys].join(' ')} }`,
@@ -477,7 +524,13 @@ export default class MySQLHandler implements MeshHandler {
// Generate limit statement
const limit = [args.limit, args.offset].filter(Boolean);
if (limit.length) {
- return mysqlConnection.selectLimit(tableName, fields, limit, args.where, args?.orderBy);
+ return mysqlConnection.selectLimit(
+ tableName,
+ fields,
+ limit,
+ args.where,
+ args?.orderBy,
+ );
} else {
return mysqlConnection.select(tableName, fields, args.where, args?.orderBy);
}
@@ -492,7 +545,8 @@ export default class MySQLHandler implements MeshHandler {
type: whereInputName,
},
},
- resolve: (root, args, { mysqlConnection }, info) => mysqlConnection.count(tableName, args.where),
+ resolve: (root, args, { mysqlConnection }, info) =>
+ mysqlConnection.count(tableName, args.where),
},
});
schemaComposer.Mutation.addFields({
@@ -540,10 +594,12 @@ export default class MySQLHandler implements MeshHandler {
},
},
resolve: (root, args, { mysqlConnection }) =>
- mysqlConnection.deleteRow(tableName, args.where).then(result => !!result?.affectedRows),
+ mysqlConnection
+ .deleteRow(tableName, args.where)
+ .then(result => !!result?.affectedRows),
},
});
- })
+ }),
);
introspectionConnection.release();
diff --git a/packages/handlers/mysql/src/mysql.d.ts b/packages/handlers/mysql/src/mysql.d.ts
index 8533a09748240..0033e61798129 100644
--- a/packages/handlers/mysql/src/mysql.d.ts
+++ b/packages/handlers/mysql/src/mysql.d.ts
@@ -73,10 +73,20 @@ declare module 'mysql' {
limit: number[],
where: any,
orderBy: any,
- callback: Callback
+ callback: Callback,
+ );
+ select(
+ tableName: string,
+ fields: string[],
+ where: any,
+ orderBy: any,
+ callback: Callback,
+ );
+ insert(
+ tableName: string,
+ record: Record,
+ callback: Callback<{ recordId: string | number }>,
);
- select(tableName: string, fields: string[], where: any, orderBy: any, callback: Callback);
- insert(tableName: string, record: Record, callback: Callback<{ recordId: string | number }>);
update(tableName: string, input: any, where: any, callback: Callback<{ affectedRows: any }>);
delete(tableName: string, where: any, callback: Callback<{ affectedRows: any }>);
count(tableName: string, where: any, callback: Callback);
diff --git a/packages/handlers/mysql/src/promisify.ts b/packages/handlers/mysql/src/promisify.ts
index c79e8a069da85..0c63a2ff1ffdd 100644
--- a/packages/handlers/mysql/src/promisify.ts
+++ b/packages/handlers/mysql/src/promisify.ts
@@ -1,23 +1,26 @@
declare module 'util' {
- export function promisify(f: (cb: (err: any, res: T) => void) => void, thisContext?: any): () => Promise;
+ export function promisify(
+ f: (cb: (err: any, res: T) => void) => void,
+ thisContext?: any,
+ ): () => Promise;
export function promisify(
f: (arg: A, cb: (err: any, res: T) => void) => void,
- thisContext?: any
+ thisContext?: any,
): (arg: A) => Promise;
export function promisify(
f: (arg: A, arg2: A2, cb: (err: any, res: T) => void) => void,
- thisContext?: any
+ thisContext?: any,
): (arg: A, arg2: A2) => Promise;
export function promisify(
f: (arg: A, arg2: A2, arg3: A3, cb: (err: any, res: T) => void) => void,
- thisContext?: any
+ thisContext?: any,
): (arg: A, arg2: A2, arg3: A3) => Promise;
export function promisify(
f: (arg: A, arg2: A2, arg3: A3, arg4: A4, cb: (err: any, res: T) => void) => void,
- thisContext?: any
+ thisContext?: any,
): (arg: A, arg2: A2, arg3: A3, arg4: A4) => Promise;
export function promisify(
f: (arg: A, arg2: A2, arg3: A3, arg4: A4, arg5: A5, cb: (err: any, res: T) => void) => void,
- thisContext?: any
+ thisContext?: any,
): (arg: A, arg2: A2, arg3: A3, arg4: A4, arg5: A5) => Promise;
}
diff --git a/packages/handlers/neo4j/src/index.ts b/packages/handlers/neo4j/src/index.ts
index 6f201d61d8af1..08723bd9f50e2 100644
--- a/packages/handlers/neo4j/src/index.ts
+++ b/packages/handlers/neo4j/src/index.ts
@@ -53,7 +53,14 @@ export default class Neo4JHandler implements MeshHandler {
fetchFn: MeshFetch;
importFn: ImportFn;
- constructor({ config, baseDir, pubsub, store, logger, importFn }: MeshHandlerOptions) {
+ constructor({
+ config,
+ baseDir,
+ pubsub,
+ store,
+ logger,
+ importFn,
+ }: MeshHandlerOptions) {
this.config = config;
this.baseDir = baseDir;
this.pubsub = pubsub;
@@ -73,9 +80,12 @@ export default class Neo4JHandler implements MeshHandler {
logger: this.logger,
});
} else {
- this.logger.info('Inferring the schema from the database: ', `"${this.config.database || 'neo4j'}"`);
+ this.logger.info(
+ 'Inferring the schema from the database: ',
+ `"${this.config.database || 'neo4j'}"`,
+ );
return toGraphQLTypeDefs(() =>
- driver.session({ database: this.config.database, defaultAccessMode: neo4j.session.READ })
+ driver.session({ database: this.config.database, defaultAccessMode: neo4j.session.READ }),
);
}
});
@@ -83,12 +93,16 @@ export default class Neo4JHandler implements MeshHandler {
async getMeshSource({ fetchFn }: GetMeshSourcePayload): Promise {
this.fetchFn = fetchFn;
- const driver = neo4j.driver(this.config.url, neo4j.auth.basic(this.config.username, this.config.password), {
- useBigInt: true,
- logging: {
- logger: (level, message) => this.logger[level](message),
+ const driver = neo4j.driver(
+ this.config.url,
+ neo4j.auth.basic(this.config.username, this.config.password),
+ {
+ useBigInt: true,
+ logging: {
+ logger: (level, message) => this.logger[level](message),
+ },
},
- });
+ );
const id = this.pubsub.subscribe('destroy', async () => {
this.pubsub.unsubscribe(id);
diff --git a/packages/handlers/odata/src/index.ts b/packages/handlers/odata/src/index.ts
index 52528ea9f6b06..bac4623265bf6 100644
--- a/packages/handlers/odata/src/index.ts
+++ b/packages/handlers/odata/src/index.ts
@@ -44,7 +44,11 @@ import {
ExecutionResult,
getNamedType,
} from 'graphql';
-import { parseResolveInfo, ResolveTree, simplifyParsedResolveInfoFragmentWithType } from 'graphql-parse-resolve-info';
+import {
+ parseResolveInfo,
+ ResolveTree,
+ simplifyParsedResolveInfoFragmentWithType,
+} from 'graphql-parse-resolve-info';
import DataLoader from 'dataloader';
import { parseResponse } from 'http-string-parser';
import { pascalCase } from 'pascal-case';
@@ -141,7 +145,14 @@ export default class ODataHandler implements MeshHandler {
preserveOrder: false,
});
- constructor({ name, config, baseDir, importFn, logger, store }: MeshHandlerOptions) {
+ constructor({
+ name,
+ config,
+ baseDir,
+ importFn,
+ logger,
+ store,
+ }: MeshHandlerOptions) {
this.name = name;
this.config = config;
this.baseDir = baseDir;
@@ -286,7 +297,7 @@ export default class ODataHandler implements MeshHandler {
urlOfElement,
entityTypeExtensions.entityInfo.identifierFieldName,
entityTypeExtensions.entityInfo.identifierFieldTypeRef,
- element
+ element,
);
const identifierUrl = element['@odata.id'] || getUrlString(urlOfElement);
const fieldMap = actualReturnType.getFields();
@@ -297,7 +308,8 @@ export default class ODataHandler implements MeshHandler {
if ('ofType' in fieldType) {
fieldType = fieldType.ofType;
}
- const { entityInfo: fieldEntityInfo } = (fieldType as any).extensions as EntityTypeExtensions;
+ const { entityInfo: fieldEntityInfo } = (fieldType as any)
+ .extensions as EntityTypeExtensions;
if (field instanceof Array) {
for (const fieldElement of field) {
const urlOfField = new URL(urljoin(identifierUrl, fieldName));
@@ -305,7 +317,7 @@ export default class ODataHandler implements MeshHandler {
urlOfField,
fieldEntityInfo.identifierFieldName,
fieldEntityInfo.identifierFieldTypeRef,
- fieldElement
+ fieldElement,
);
fieldElement['@odata.id'] = fieldElement['@odata.id'] || getUrlString(urlOfField);
}
@@ -315,7 +327,7 @@ export default class ODataHandler implements MeshHandler {
urlOfField,
fieldEntityInfo.identifierFieldName,
fieldEntityInfo.identifierFieldTypeRef,
- field
+ field,
);
field['@odata.id'] = field['@odata.id'] || getUrlString(urlOfField);
}
@@ -341,7 +353,8 @@ export default class ODataHandler implements MeshHandler {
if ('ofType' in fieldType) {
fieldType = fieldType.ofType;
}
- const { entityInfo: fieldEntityInfo } = (fieldType as any).extensions as EntityTypeExtensions;
+ const { entityInfo: fieldEntityInfo } = (fieldType as any)
+ .extensions as EntityTypeExtensions;
if (field instanceof Array) {
for (const fieldElement of field) {
const urlOfField = new URL(urljoin(identifierUrl, fieldName));
@@ -349,7 +362,7 @@ export default class ODataHandler implements MeshHandler {
urlOfField,
fieldEntityInfo.identifierFieldName,
fieldEntityInfo.identifierFieldTypeRef,
- fieldElement
+ fieldElement,
);
fieldElement['@odata.id'] = fieldElement['@odata.id'] || getUrlString(urlOfField);
}
@@ -359,7 +372,7 @@ export default class ODataHandler implements MeshHandler {
urlOfField,
fieldEntityInfo.identifierFieldName,
fieldEntityInfo.identifierFieldTypeRef,
- field
+ field,
);
field['@odata.id'] = field['@odata.id'] || getUrlString(urlOfField);
}
@@ -418,7 +431,12 @@ export default class ODataHandler implements MeshHandler {
return null;
}
- function addIdentifierToUrl(url: URL, identifierFieldName: string, identifierFieldTypeRef: string, args: any) {
+ function addIdentifierToUrl(
+ url: URL,
+ identifierFieldName: string,
+ identifierFieldTypeRef: string,
+ args: any,
+ ) {
url.href += `/${args[identifierFieldName]}/`;
}
@@ -446,7 +464,7 @@ export default class ODataHandler implements MeshHandler {
const error = new Error(
batchResponseJson.ExceptionMessage ||
batchResponseJson.Message ||
- `Batch Request didn't return a valid response.`
+ `Batch Request didn't return a valid response.`,
);
Object.assign(error, {
extensions: batchResponseJson,
@@ -454,7 +472,9 @@ export default class ODataHandler implements MeshHandler {
throw error;
}
return requests.map((_req, index) => {
- const responseObj = batchResponseJson.responses.find((res: any) => res.id === index.toString());
+ const responseObj = batchResponseJson.responses.find(
+ (res: any) => res.id === index.toString(),
+ );
return new Response(JSON.stringify(responseObj.body), {
status: responseObj.status,
headers: responseObj.headers,
@@ -491,7 +511,7 @@ export default class ODataHandler implements MeshHandler {
context,
env: process.env,
},
- 'POST'
+ 'POST',
);
batchHeaders['content-type'] = `multipart/mixed;boundary=${requestBoundary}`;
const batchResponse = await this.fetchFn(urljoin(baseUrl, '$batch'), {
@@ -525,7 +545,7 @@ export default class ODataHandler implements MeshHandler {
context,
env: process.env,
},
- 'POST'
+ 'POST',
);
batchHeaders['content-type'] = 'application/json';
const batchResponse = await this.fetchFn(urljoin(baseUrl, '$batch'), {
@@ -547,7 +567,7 @@ export default class ODataHandler implements MeshHandler {
body: request.body && (await request.json()),
headers,
};
- })
+ }),
),
}),
headers: batchHeaders,
@@ -565,9 +585,9 @@ export default class ODataHandler implements MeshHandler {
method: request.method,
body: request.body && (await request.text()),
headers: request.headers,
- })
- )
- )
+ }),
+ ),
+ ),
),
};
@@ -636,7 +656,9 @@ export default class ODataHandler implements MeshHandler {
});
let abstractType: InterfaceTypeComposer;
if (
- typesWithBaseType.some((typeObj: any) => typeObj.attributes.BaseType.includes(`.${entityTypeName}`)) ||
+ typesWithBaseType.some((typeObj: any) =>
+ typeObj.attributes.BaseType.includes(`.${entityTypeName}`),
+ ) ||
isAbstract
) {
abstractType = schemaComposer.createInterfaceTC({
@@ -733,7 +755,12 @@ export default class ODataHandler implements MeshHandler {
url.href = urljoin(url.href, '/' + navigationPropertyName);
const returnType = info.returnType as GraphQLObjectType;
const { entityInfo } = returnType.extensions as unknown as EntityTypeExtensions;
- addIdentifierToUrl(url, entityInfo.identifierFieldName, entityInfo.identifierFieldTypeRef, args);
+ addIdentifierToUrl(
+ url,
+ entityInfo.identifierFieldName,
+ entityInfo.identifierFieldTypeRef,
+ args,
+ );
const parsedInfoFragment = parseResolveInfo(info) as ResolveTree;
const searchParams = this.prepareSearchParams(parsedInfoFragment, info.schema);
searchParams?.forEach((value, key) => {
@@ -751,7 +778,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -793,7 +820,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -843,7 +870,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -880,7 +907,9 @@ export default class ODataHandler implements MeshHandler {
});
}
const updateInputType = inputType.clone(`${entityTypeName}UpdateInput`);
- updateInputType.getFieldNames()?.forEach(fieldName => updateInputType.makeOptional(fieldName));
+ updateInputType
+ .getFieldNames()
+ ?.forEach(fieldName => updateInputType.makeOptional(fieldName));
// Types might be considered as unused implementations of interfaces so we must prevent that
schemaComposer.addSchemaMustHaveType(outputType);
});
@@ -923,7 +952,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -996,7 +1025,10 @@ export default class ODataHandler implements MeshHandler {
if (argsEntries.length) {
url.href += `(${argsEntries
.filter(argEntry => argEntry[0] !== 'queryOptions')
- .map(([argName, value]) => [argName, typeof value === 'string' ? `'${value}'` : value])
+ .map(([argName, value]) => [
+ argName,
+ typeof value === 'string' ? `'${value}'` : value,
+ ])
.map(argEntry => argEntry.join('='))
.join(',')})`;
}
@@ -1017,7 +1049,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1030,10 +1062,12 @@ export default class ODataHandler implements MeshHandler {
type: parameterTypeName,
};
});
- const boundEntityType = schemaComposer.getAnyTC(boundEntityTypeName) as InterfaceTypeComposer;
+ const boundEntityType = schemaComposer.getAnyTC(
+ boundEntityTypeName,
+ ) as InterfaceTypeComposer;
const boundEntityOtherType = getTCByTypeNames(
'I' + boundEntityTypeName,
- 'T' + boundEntityTypeName
+ 'T' + boundEntityTypeName,
) as InterfaceTypeComposer;
boundEntityType.addFields({
[functionName]: field,
@@ -1074,7 +1108,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
body: JSON.stringify(args),
});
@@ -1148,7 +1182,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
body: JSON.stringify(args),
});
@@ -1162,13 +1196,15 @@ export default class ODataHandler implements MeshHandler {
type: parameterTypeName,
};
});
- const boundEntityType = schemaComposer.getAnyTC(boundEntityTypeName) as InterfaceTypeComposer;
+ const boundEntityType = schemaComposer.getAnyTC(
+ boundEntityTypeName,
+ ) as InterfaceTypeComposer;
boundEntityType.addFields({
[actionName]: boundField,
});
const otherType = getTCByTypeNames(
`I${boundEntityTypeName}`,
- `T${boundEntityTypeName}`
+ `T${boundEntityTypeName}`,
) as InterfaceTypeComposer;
otherType?.addFields({
[actionName]: boundField,
@@ -1200,13 +1236,20 @@ export default class ODataHandler implements MeshHandler {
isRequired: false,
});
const baseInputType = schemaComposer.getAnyTC(baseTypeName + 'Input') as InputTypeComposer;
- const baseAbstractType = getTCByTypeNames('I' + baseTypeName, baseTypeName) as InterfaceTypeComposer;
- const baseOutputType = getTCByTypeNames('T' + baseTypeName, baseTypeName) as ObjectTypeComposer;
+ const baseAbstractType = getTCByTypeNames(
+ 'I' + baseTypeName,
+ baseTypeName,
+ ) as InterfaceTypeComposer;
+ const baseOutputType = getTCByTypeNames(
+ 'T' + baseTypeName,
+ baseTypeName,
+ ) as ObjectTypeComposer;
const { entityInfo: baseEntityInfo, eventEmitter: baseEventEmitter } =
baseOutputType.getExtensions() as EntityTypeExtensions;
const baseEventEmitterListener = () => {
inputType.addFields(baseInputType.getFields());
- entityInfo.identifierFieldName = baseEntityInfo.identifierFieldName || entityInfo.identifierFieldName;
+ entityInfo.identifierFieldName =
+ baseEntityInfo.identifierFieldName || entityInfo.identifierFieldName;
entityInfo.identifierFieldTypeRef =
baseEntityInfo.identifierFieldTypeRef || entityInfo.identifierFieldTypeRef;
entityInfo.actualFields.unshift(...baseEntityInfo.actualFields);
@@ -1259,7 +1302,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1313,7 +1356,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1350,7 +1393,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1382,7 +1425,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1417,7 +1460,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
body: JSON.stringify(args.input),
});
@@ -1450,7 +1493,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
});
const response = await context[contextDataloaderName].load(request);
@@ -1486,7 +1529,7 @@ export default class ODataHandler implements MeshHandler {
info,
env: process.env,
},
- method
+ method,
),
body: JSON.stringify(args.input),
});
diff --git a/packages/handlers/odata/test/handler.spec.ts b/packages/handlers/odata/test/handler.spec.ts
index 28b34e6c3e90c..c2b6cf3f83c53 100644
--- a/packages/handlers/odata/test/handler.spec.ts
+++ b/packages/handlers/odata/test/handler.spec.ts
@@ -8,10 +8,20 @@ import { PubSub, DefaultLogger } from '@graphql-mesh/utils';
import ODataHandler from '../src/index.js';
import { InMemoryStoreStorageAdapter, MeshStore } from '@graphql-mesh/store';
-const TripPinMetadata = fs.readFileSync(path.resolve(__dirname, './fixtures/trippin-metadata.xml'), 'utf8');
-const PersonMockData = JSON.parse(fs.readFileSync(path.resolve(__dirname, './fixtures/russellwhyte.json'), 'utf-8'));
-const TripMockData = JSON.parse(fs.readFileSync(path.resolve(__dirname, './fixtures/trip.json'), 'utf-8'));
-const BasicMetadata = fs.readFileSync(path.resolve(__dirname, './fixtures/simple-metadata.xml'), 'utf-8');
+const TripPinMetadata = fs.readFileSync(
+ path.resolve(__dirname, './fixtures/trippin-metadata.xml'),
+ 'utf8',
+);
+const PersonMockData = JSON.parse(
+ fs.readFileSync(path.resolve(__dirname, './fixtures/russellwhyte.json'), 'utf-8'),
+);
+const TripMockData = JSON.parse(
+ fs.readFileSync(path.resolve(__dirname, './fixtures/trip.json'), 'utf-8'),
+);
+const BasicMetadata = fs.readFileSync(
+ path.resolve(__dirname, './fixtures/simple-metadata.xml'),
+ 'utf-8',
+);
const baseDir = __dirname;
const importFn = (id: string) => require(id);
@@ -34,7 +44,7 @@ describe('odata', () => {
it('should create a GraphQL schema from a simple OData endpoint', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const handler = new ODataHandler({
name: 'TripPin',
@@ -75,7 +85,7 @@ describe('odata', () => {
it('should declare arguments for fields created from bound functions', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const handler = new ODataHandler({
name: 'TripPin',
@@ -105,7 +115,7 @@ describe('odata', () => {
it('should generate correct HTTP request for requesting an EntitySet', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = 'https://services.odata.org/TripPinRESTierService/People';
const correctMethod = 'GET';
@@ -149,7 +159,7 @@ describe('odata', () => {
it('should generate correct HTTP request for requesting a single Entity by ID', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/SOMEID/`;
const correctMethod = 'GET';
@@ -193,7 +203,7 @@ describe('odata', () => {
it('should generate correct HTTP request for requesting a complex property', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/Airports/KSFO/?$select=IcaoCode,Location`;
const correctMethod = 'GET';
@@ -208,7 +218,7 @@ describe('odata', () => {
'@odata.type': 'Microsoft.OData.Service.Sample.TrippinInMemory.Models.AirportLocation',
Loc: '',
},
- })
+ }),
);
});
const handler = new ODataHandler({
@@ -248,7 +258,7 @@ describe('odata', () => {
it('should generate correct HTTP request for query options', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People?$filter=FirstName eq 'Scott'`;
const correctMethod = 'GET';
@@ -292,7 +302,7 @@ describe('odata', () => {
it('should generate correct HTTP request for $count', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/$count`;
const correctMethod = 'GET';
@@ -333,7 +343,7 @@ describe('odata', () => {
it('should generate correct HTTP request for creating an entity', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People`;
const correctMethod = 'POST';
@@ -401,7 +411,7 @@ describe('odata', () => {
it('should generate correct HTTP request for deleting an entity', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/SOMEID/`;
const correctMethod = 'DELETE';
@@ -442,7 +452,7 @@ describe('odata', () => {
it('should generate correct HTTP request for updating an entity', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/SOMEID/`;
const correctMethod = 'PATCH';
@@ -496,7 +506,7 @@ describe('odata', () => {
it('should generate correct HTTP request for invoking unbound functions', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/GetNearestAirport(lat = 33, lon = -118)?$select=IcaoCode,Name`;
const correctMethod = 'GET';
@@ -508,7 +518,7 @@ describe('odata', () => {
'@odata.type': 'Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport',
IcaoCode: Date.now().toString(),
Name: 'Name',
- })
+ }),
);
});
const handler = new ODataHandler({
@@ -546,7 +556,7 @@ describe('odata', () => {
it('should generate correct HTTP request for invoking bound functions', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/russellwhyte/Trips/0/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetInvolvedPeople?$select=UserName`;
const correctMethod = 'GET';
@@ -558,14 +568,14 @@ describe('odata', () => {
`https://services.odata.org/TripPinRESTierService/People/russellwhyte/Trips?$filter=TripId eq 0&$select=TripId`,
async () => {
return new MockResponse(JSON.stringify(TripMockData));
- }
+ },
);
addMock(correctUrl, async request => {
sentRequest = request;
return new MockResponse(
JSON.stringify({
value: [],
- })
+ }),
);
});
const handler = new ODataHandler({
@@ -608,7 +618,7 @@ describe('odata', () => {
it('should generate correct HTTP request for invoking bound functions with arguments', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/russellwhyte/Microsoft.OData.Service.Sample.TrippinInMemory.Models.GetFriendsTrips(userName='ronaldmundy')?$select=TripId,Name`;
const correctMethod = 'GET';
@@ -621,7 +631,7 @@ describe('odata', () => {
return new MockResponse(
JSON.stringify({
value: [],
- })
+ }),
);
});
const handler = new ODataHandler({
@@ -662,7 +672,7 @@ describe('odata', () => {
it('should generate correct HTTP request for invoking unbound actions', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/ResetDataSource`;
const correctMethod = 'POST';
@@ -703,7 +713,7 @@ describe('odata', () => {
it('should generate correct HTTP request for invoking bound actions', async () => {
addMock(
'https://services.odata.org/TripPinRESTierService/$metadata',
- async () => new MockResponse(TripPinMetadata)
+ async () => new MockResponse(TripPinMetadata),
);
const correctUrl = `https://services.odata.org/TripPinRESTierService/People/russellwhyte/Microsoft.OData.Service.Sample.TrippinInMemory.Models.ShareTrip`;
const correctMethod = 'POST';
diff --git a/packages/handlers/openapi/src/index.ts b/packages/handlers/openapi/src/index.ts
index 7b7e7f9cc8961..e2d8e5af89254 100644
--- a/packages/handlers/openapi/src/index.ts
+++ b/packages/handlers/openapi/src/index.ts
@@ -34,7 +34,10 @@ export default class OpenAPIHandler implements MeshHandler {
this.name = name;
this.config = config;
this.baseDir = baseDir;
- this.bundleStoreProxy = store.proxy('jsonSchemaBundle', PredefinedProxyOptions.JsonWithoutValidation);
+ this.bundleStoreProxy = store.proxy(
+ 'jsonSchemaBundle',
+ PredefinedProxyOptions.JsonWithoutValidation,
+ );
this.pubsub = pubsub;
this.logger = logger;
this.importFn = importFn;
@@ -49,12 +52,15 @@ export default class OpenAPIHandler implements MeshHandler {
fetch: this.fetchFn,
logger: this.logger,
ignoreErrorResponses: this.config.ignoreErrorResponses,
- selectQueryOrMutationField: this.config.selectQueryOrMutationField?.map(({ type, fieldName }) => ({
- type: type.toLowerCase() as any,
- fieldName,
- })),
+ selectQueryOrMutationField: this.config.selectQueryOrMutationField?.map(
+ ({ type, fieldName }) => ({
+ type: type.toLowerCase() as any,
+ fieldName,
+ }),
+ ),
fallbackFormat: this.config.fallbackFormat,
- operationHeaders: typeof this.config.operationHeaders === 'string' ? {} : this.config.operationHeaders,
+ operationHeaders:
+ typeof this.config.operationHeaders === 'string' ? {} : this.config.operationHeaders,
});
});
}
@@ -66,11 +72,14 @@ export default class OpenAPIHandler implements MeshHandler {
this.logger?.debug('Generating GraphQL Schema from bundle');
const operationHeadersConfig =
typeof this.config.operationHeaders === 'string'
- ? await loadFromModuleExportExpression>(this.config.operationHeaders, {
- cwd: this.baseDir,
- importFn: this.importFn,
- defaultExportName: 'default',
- })
+ ? await loadFromModuleExportExpression>(
+ this.config.operationHeaders,
+ {
+ cwd: this.baseDir,
+ importFn: this.importFn,
+ defaultExportName: 'default',
+ },
+ )
: this.config.operationHeaders;
const schema = await getGraphQLSchemaFromBundle(bundle, {
cwd: this.baseDir,
diff --git a/packages/handlers/postgraphile/src/index.ts b/packages/handlers/postgraphile/src/index.ts
index 2aca319c19a56..780c6f5413fce 100644
--- a/packages/handlers/postgraphile/src/index.ts
+++ b/packages/handlers/postgraphile/src/index.ts
@@ -60,7 +60,9 @@ export default class PostGraphileHandler implements MeshHandler {
if (!pgPool || !('connect' in pgPool)) {
const pgLogger = this.logger.child('PostgreSQL');
pgPool = new pg.Pool({
- connectionString: stringInterpolator.parse(this.config.connectionString, { env: process.env }),
+ connectionString: stringInterpolator.parse(this.config.connectionString, {
+ env: process.env,
+ }),
log: messages => pgLogger.debug(messages),
...this.config?.pool,
});
@@ -85,8 +87,8 @@ export default class PostGraphileHandler implements MeshHandler {
cwd: this.baseDir,
importFn: this.importFn,
defaultExportName: 'default',
- })
- )
+ }),
+ ),
);
const skipPlugins = await Promise.all(
(this.config.skipPlugins || []).map(pluginName =>
@@ -94,8 +96,8 @@ export default class PostGraphileHandler implements MeshHandler {
cwd: this.baseDir,
importFn: this.importFn,
defaultExportName: 'default',
- })
- )
+ }),
+ ),
);
const options = await loadFromModuleExportExpression(this.config.options, {
cwd: this.baseDir,
@@ -129,7 +131,14 @@ export default class PostGraphileHandler implements MeshHandler {
return {
schema,
- executor({ document, variables, context: meshContext, rootValue, operationName, extensions }) {
+ executor({
+ document,
+ variables,
+ context: meshContext,
+ rootValue,
+ operationName,
+ extensions,
+ }) {
return withPostGraphileContext(
{
pgPool,
@@ -149,7 +158,7 @@ export default class PostGraphileHandler implements MeshHandler {
operationName,
extensions,
}) as any;
- }
+ },
) as any;
},
};
diff --git a/packages/handlers/raml/src/index.ts b/packages/handlers/raml/src/index.ts
index fa0be1a86ab4a..b00b319c803dc 100644
--- a/packages/handlers/raml/src/index.ts
+++ b/packages/handlers/raml/src/index.ts
@@ -19,11 +19,21 @@ export default class RAMLHandler implements MeshHandler {
private logger: Logger;
private fetchFn: MeshFetch;
private pubsub: MeshPubSub;
- constructor({ name, config, baseDir, store, pubsub, logger }: MeshHandlerOptions) {
+ constructor({
+ name,
+ config,
+ baseDir,
+ store,
+ pubsub,
+ logger,
+ }: MeshHandlerOptions) {
this.name = name;
this.config = config;
this.baseDir = baseDir;
- this.bundleStoreProxy = store.proxy('jsonSchemaBundle', PredefinedProxyOptions.JsonWithoutValidation);
+ this.bundleStoreProxy = store.proxy(
+ 'jsonSchemaBundle',
+ PredefinedProxyOptions.JsonWithoutValidation,
+ );
this.pubsub = pubsub;
this.logger = logger;
}
@@ -36,10 +46,12 @@ export default class RAMLHandler implements MeshHandler {
fetch: this.fetchFn,
logger: this.logger,
ignoreErrorResponses: this.config.ignoreErrorResponses,
- selectQueryOrMutationField: this.config.selectQueryOrMutationField?.map(({ type, fieldName }) => ({
- type: type.toLowerCase() as any,
- fieldName,
- })),
+ selectQueryOrMutationField: this.config.selectQueryOrMutationField?.map(
+ ({ type, fieldName }) => ({
+ type: type.toLowerCase() as any,
+ fieldName,
+ }),
+ ),
});
});
}
diff --git a/packages/handlers/soap/src/index.ts b/packages/handlers/soap/src/index.ts
index 9331935e98c40..066b66337fab0 100644
--- a/packages/handlers/soap/src/index.ts
+++ b/packages/handlers/soap/src/index.ts
@@ -20,9 +20,18 @@ export default class SoapHandler implements MeshHandler {
private importFn: ImportFn;
private logger: Logger;
- constructor({ config, store, baseDir, importFn, logger }: MeshHandlerOptions) {
+ constructor({
+ config,
+ store,
+ baseDir,
+ importFn,
+ logger,
+ }: MeshHandlerOptions) {
this.config = config;
- this.soapSDLProxy = store.proxy('schemaWithAnnotations.graphql', PredefinedProxyOptions.GraphQLSchemaWithDiffing);
+ this.soapSDLProxy = store.proxy(
+ 'schemaWithAnnotations.graphql',
+ PredefinedProxyOptions.GraphQLSchemaWithDiffing,
+ );
this.baseDir = baseDir;
this.importFn = importFn;
this.logger = logger;
diff --git a/packages/handlers/thrift/src/index.ts b/packages/handlers/thrift/src/index.ts
index 10620a544e842..7e0271fe812cc 100644
--- a/packages/handlers/thrift/src/index.ts
+++ b/packages/handlers/thrift/src/index.ts
@@ -8,7 +8,13 @@ import {
GetMeshSourcePayload,
MeshSource,
} from '@graphql-mesh/types';
-import { parse, ThriftDocument, SyntaxType, Comment, FunctionType } from '@creditkarma/thrift-parser';
+import {
+ parse,
+ ThriftDocument,
+ SyntaxType,
+ Comment,
+ FunctionType,
+} from '@creditkarma/thrift-parser';
import { readFileOrUrl } from '@graphql-mesh/utils';
import {
GraphQLEnumType,
@@ -48,7 +54,10 @@ import {
import { pascalCase } from 'pascal-case';
import { PredefinedProxyOptions, StoreProxy } from '@graphql-mesh/store';
import { AggregateError } from '@graphql-tools/utils';
-import { parseInterpolationStrings, getInterpolatedHeadersFactory } from '@graphql-mesh/string-interpolation';
+import {
+ parseInterpolationStrings,
+ getInterpolatedHeadersFactory,
+} from '@graphql-mesh/string-interpolation';
import { process, util } from '@graphql-mesh/cross-helpers';
export default class ThriftHandler implements MeshHandler {
@@ -59,7 +68,13 @@ export default class ThriftHandler implements MeshHandler {
private importFn: ImportFn;
private logger: Logger;
- constructor({ config, baseDir, store, importFn, logger }: MeshHandlerOptions) {
+ constructor({
+ config,
+ baseDir,
+ store,
+ importFn,
+ logger,
+ }: MeshHandlerOptions) {
this.config = config;
this.baseDir = baseDir;
this.idl = store.proxy('idl.json', PredefinedProxyOptions.JsonWithoutValidation);
@@ -101,10 +116,24 @@ export default class ThriftHandler implements MeshHandler {
[methodName: string]: number;
} = {};
- type TypeVal = BaseTypeVal | ListTypeVal | SetTypeVal | MapTypeVal | EnumTypeVal | StructTypeVal | VoidTypeVal;
+ type TypeVal =
+ | BaseTypeVal
+ | ListTypeVal
+ | SetTypeVal
+ | MapTypeVal
+ | EnumTypeVal
+ | StructTypeVal
+ | VoidTypeVal;
type BaseTypeVal = {
id?: number;
- type: TType.BOOL | TType.BYTE | TType.DOUBLE | TType.I16 | TType.I32 | TType.I64 | TType.STRING;
+ type:
+ | TType.BOOL
+ | TType.BYTE
+ | TType.DOUBLE
+ | TType.I16
+ | TType.I32
+ | TType.I64
+ | TType.STRING;
};
type ListTypeVal = { id?: number; type: TType.LIST; elementType: TypeVal };
type SetTypeVal = { id?: number; type: TType.SET; elementType: TypeVal };
@@ -282,7 +311,7 @@ export default class ThriftHandler implements MeshHandler {
id,
},
args,
- output
+ output,
);
output.writeMessageEnd();
const data: Buffer = await this.connection.send(writer.flush(), context);
@@ -302,14 +331,14 @@ export default class ThriftHandler implements MeshHandler {
} else {
throw new TApplicationException(
TApplicationExceptionType.UNKNOWN,
- methodName + ' failed: unknown result'
+ methodName + ' failed: unknown result',
);
}
}
} else {
throw new TApplicationException(
TApplicationExceptionType.WRONG_METHOD_NAME,
- 'Received a response to an unknown RPC function: ' + fieldName
+ 'Received a response to an unknown RPC function: ' + fieldName,
);
}
}
@@ -327,7 +356,7 @@ export default class ThriftHandler implements MeshHandler {
function getGraphQLFunctionType(
functionType: FunctionType,
- id = Math.random()
+ id = Math.random(),
): { outputType: GraphQLOutputType; inputType: GraphQLInputType; typeVal: TypeVal } {
let inputType: GraphQLInputType;
let outputType: GraphQLOutputType;
@@ -397,7 +426,11 @@ export default class ThriftHandler implements MeshHandler {
outputType = GraphQLJSON;
const ofTypeKey = getGraphQLFunctionType(functionType.keyType, id);
const ofTypeValue = getGraphQLFunctionType(functionType.valueType, id);
- typeVal = typeVal! || { type: TType.MAP, keyType: ofTypeKey.typeVal, valType: ofTypeValue.typeVal };
+ typeVal = typeVal! || {
+ type: TType.MAP,
+ keyType: ofTypeKey.typeVal,
+ valType: ofTypeValue.typeVal,
+ };
break;
}
case SyntaxType.Identifier: {
@@ -429,7 +462,9 @@ export default class ThriftHandler implements MeshHandler {
};
}
- const { args: commonArgs, contextVariables } = parseInterpolationStrings(Object.values(operationHeaders || {}));
+ const { args: commonArgs, contextVariables } = parseInterpolationStrings(
+ Object.values(operationHeaders || {}),
+ );
const headersFactory = getInterpolatedHeadersFactory(operationHeaders);
@@ -449,9 +484,9 @@ export default class ThriftHandler implements MeshHandler {
value: curr.name.value,
},
}),
- {} as GraphQLEnumValueConfigMap
+ {} as GraphQLEnumValueConfigMap,
),
- })
+ }),
);
break;
case SyntaxType.StructDefinition: {
@@ -472,7 +507,10 @@ export default class ThriftHandler implements MeshHandler {
let fieldOutputType: GraphQLOutputType;
let fieldInputType: GraphQLInputType;
const description = processComments(field.comments);
- const processedFieldTypes = getGraphQLFunctionType(field.fieldType, field.fieldID?.value);
+ const processedFieldTypes = getGraphQLFunctionType(
+ field.fieldType,
+ field.fieldID?.value,
+ );
fieldOutputType = processedFieldTypes.outputType;
fieldInputType = processedFieldTypes.inputType;
@@ -497,7 +535,7 @@ export default class ThriftHandler implements MeshHandler {
name: structName,
description,
fields: objectFields,
- })
+ }),
);
inputTypeMap.set(
structName,
@@ -505,7 +543,7 @@ export default class ThriftHandler implements MeshHandler {
name: structName + 'Input',
description,
fields: inputObjectFields,
- })
+ }),
);
break;
}
@@ -514,20 +552,28 @@ export default class ThriftHandler implements MeshHandler {
const fn = statement.functions[fnIndex];
const fnName = fn.name.value;
const description = processComments(fn.comments);
- const { outputType: returnType } = getGraphQLFunctionType(fn.returnType, Number(fnIndex) + 1);
+ const { outputType: returnType } = getGraphQLFunctionType(
+ fn.returnType,
+ Number(fnIndex) + 1,
+ );
const args: GraphQLFieldConfigArgumentMap = {};
for (const argName in commonArgs) {
const typeNameOrType = commonArgs[argName].type;
args[argName] = {
type:
- typeof typeNameOrType === 'string' ? inputTypeMap.get(typeNameOrType) : typeNameOrType || GraphQLID,
+ typeof typeNameOrType === 'string'
+ ? inputTypeMap.get(typeNameOrType)
+ : typeNameOrType || GraphQLID,
};
}
const fieldTypeMap: TypeMap = {};
for (const field of fn.fields) {
const fieldName = field.name.value;
const fieldDescription = processComments(field.comments);
- let { inputType: fieldType, typeVal } = getGraphQLFunctionType(field.fieldType, field.fieldID?.value);
+ let { inputType: fieldType, typeVal } = getGraphQLFunctionType(
+ field.fieldType,
+ field.fieldID?.value,
+ );
if (field.requiredness === 'required') {
fieldType = new GraphQLNonNull(fieldType);
}
@@ -552,7 +598,10 @@ export default class ThriftHandler implements MeshHandler {
}
break;
case SyntaxType.TypedefDefinition: {
- const { inputType, outputType } = getGraphQLFunctionType(statement.definitionType, Math.random());
+ const { inputType, outputType } = getGraphQLFunctionType(
+ statement.definitionType,
+ Math.random(),
+ );
const typeName = statement.name.value;
inputTypeMap.set(typeName, inputType);
outputTypeMap.set(typeName, outputType);
diff --git a/packages/handlers/thrift/test/handler.spec.ts b/packages/handlers/thrift/test/handler.spec.ts
index 215e62e8af2bd..33160e0853b60 100644
--- a/packages/handlers/thrift/test/handler.spec.ts
+++ b/packages/handlers/thrift/test/handler.spec.ts
@@ -21,7 +21,10 @@ describe('thrift', () => {
},
cache: new InMemoryLRUCache(),
pubsub: new PubSub(),
- store: new MeshStore('.mesh', new InMemoryStoreStorageAdapter(), { readonly: false, validate: false }),
+ store: new MeshStore('.mesh', new InMemoryStoreStorageAdapter(), {
+ readonly: false,
+ validate: false,
+ }),
baseDir: __dirname,
logger: new DefaultLogger('TEST'),
importFn: m => import(m),
diff --git a/packages/handlers/tuql/src/index.ts b/packages/handlers/tuql/src/index.ts
index 2e4f063613fd5..326113a5417bc 100644
--- a/packages/handlers/tuql/src/index.ts
+++ b/packages/handlers/tuql/src/index.ts
@@ -13,10 +13,14 @@ export default class TuqlHandler implements MeshHandler {
async getMeshSource(): Promise {
const schema = await (this.config.infile
? buildSchemaFromInfile(
- path.isAbsolute(this.config.infile) ? this.config.db : path.join(this.baseDir, this.config.infile)
+ path.isAbsolute(this.config.infile)
+ ? this.config.db
+ : path.join(this.baseDir, this.config.infile),
)
: buildSchemaFromDatabase(
- path.isAbsolute(this.config.db) ? this.config.infile : path.join(this.baseDir, this.config.db)
+ path.isAbsolute(this.config.db)
+ ? this.config.infile
+ : path.join(this.baseDir, this.config.db),
));
return {
diff --git a/packages/jit-executor/src/index.ts b/packages/jit-executor/src/index.ts
index 497d679afe709..dbed833f7e31d 100644
--- a/packages/jit-executor/src/index.ts
+++ b/packages/jit-executor/src/index.ts
@@ -1,4 +1,9 @@
-import { ExecutionRequest, Executor, getOperationASTFromRequest, memoize1 } from '@graphql-tools/utils';
+import {
+ ExecutionRequest,
+ Executor,
+ getOperationASTFromRequest,
+ memoize1,
+} from '@graphql-tools/utils';
import { CompiledQuery, compileQuery, isCompiledQuery } from 'graphql-jit';
import { createLruCache, printWithCache } from '@graphql-mesh/utils';
import { ExecutionResult, GraphQLSchema } from 'graphql';
@@ -15,7 +20,8 @@ export function createJITExecutor(schema: GraphQLSchema, prefix: string, logger:
const documentStr = printWithCache(document);
logger.debug(`Executing ${documentStr}`);
const cacheKey = [prefix, documentStr, operationName].join('_');
- let compiledQueryFn: CompiledQuery['query'] | CompiledQuery['subscribe'] = lruCache.get(cacheKey);
+ let compiledQueryFn: CompiledQuery['query'] | CompiledQuery['subscribe'] =
+ lruCache.get(cacheKey);
if (!compiledQueryFn) {
logger.debug(`Compiling ${documentStr}`);
const compiledQuery = compileQuery(schema, document, operationName);
diff --git a/packages/json-machete/src/compareJSONSchemas.ts b/packages/json-machete/src/compareJSONSchemas.ts
index fbc164e66a20a..b92c48f7cbea0 100644
--- a/packages/json-machete/src/compareJSONSchemas.ts
+++ b/packages/json-machete/src/compareJSONSchemas.ts
@@ -18,12 +18,16 @@ export async function compareJSONSchemas(oldSchema: JSONSchema, newSchema: JSONS
} else {
if (oldSubSchema.$ref) {
if (newSubSchema?.$ref !== oldSubSchema.$ref) {
- breakingChanges.push(`${path}/$ref is changed from ${oldSubSchema.$ref} to ${newSubSchema?.$ref}`);
+ breakingChanges.push(
+ `${path}/$ref is changed from ${oldSubSchema.$ref} to ${newSubSchema?.$ref}`,
+ );
}
}
if (oldSubSchema.const) {
if (newSubSchema?.const !== oldSubSchema.const) {
- breakingChanges.push(`${path}/const is changed from ${oldSubSchema.const} to ${newSubSchema?.const}`);
+ breakingChanges.push(
+ `${path}/const is changed from ${oldSubSchema.const} to ${newSubSchema?.const}`,
+ );
}
}
if (oldSubSchema.enum) {
@@ -36,28 +40,28 @@ export async function compareJSONSchemas(oldSchema: JSONSchema, newSchema: JSONS
if (oldSubSchema.format) {
if (newSubSchema?.format !== oldSubSchema.format) {
breakingChanges.push(
- `${path}/format is changed from ${oldSubSchema.format} to ${newSubSchema?.format}`
+ `${path}/format is changed from ${oldSubSchema.format} to ${newSubSchema?.format}`,
);
}
}
if (oldSubSchema.maxLength) {
if (oldSubSchema.maxLength > newSubSchema?.maxLength) {
breakingChanges.push(
- `${path}/maxLength is changed from ${oldSubSchema.maxLength} to ${newSubSchema?.maxLength}`
+ `${path}/maxLength is changed from ${oldSubSchema.maxLength} to ${newSubSchema?.maxLength}`,
);
}
}
if (oldSubSchema.minLength) {
if (oldSubSchema.minLength < newSubSchema?.minLength) {
breakingChanges.push(
- `${path}/minLength is changed from ${oldSubSchema.minLength} to ${newSubSchema?.minLength}`
+ `${path}/minLength is changed from ${oldSubSchema.minLength} to ${newSubSchema?.minLength}`,
);
}
}
if (oldSubSchema.pattern) {
if (newSubSchema?.pattern?.toString() !== oldSubSchema.pattern.toString()) {
breakingChanges.push(
- `${path}/pattern is changed from ${oldSubSchema.pattern} to ${newSubSchema?.pattern}`
+ `${path}/pattern is changed from ${oldSubSchema.pattern} to ${newSubSchema?.pattern}`,
);
}
}
@@ -80,7 +84,9 @@ export async function compareJSONSchemas(oldSchema: JSONSchema, newSchema: JSONS
if (oldSubSchema.title) {
if (newSubSchema?.title !== oldSubSchema.title) {
- breakingChanges.push(`${path}/title is changed from ${oldSubSchema.title} to ${newSubSchema?.title}`);
+ breakingChanges.push(
+ `${path}/title is changed from ${oldSubSchema.title} to ${newSubSchema?.title}`,
+ );
}
}
@@ -94,7 +100,9 @@ export async function compareJSONSchemas(oldSchema: JSONSchema, newSchema: JSONS
: !newSubSchema?.type.includes(oldSubSchema.type)
: true
) {
- breakingChanges.push(`${path}/type is changed from ${oldSubSchema.type} to ${newSubSchema?.type}`);
+ breakingChanges.push(
+ `${path}/type is changed from ${oldSubSchema.type} to ${newSubSchema?.type}`,
+ );
}
}
}
@@ -105,12 +113,12 @@ export async function compareJSONSchemas(oldSchema: JSONSchema, newSchema: JSONS
{
visitedSubschemaResultMap: new WeakMap(),
path: '',
- }
+ },
);
if (breakingChanges.length > 0) {
throw new AggregateError(
breakingChanges.map(breakingChange => new Error(breakingChange)),
- `Breaking changes are found:\n${breakingChanges.join('\n')}`
+ `Breaking changes are found:\n${breakingChanges.join('\n')}`,
);
}
}
diff --git a/packages/json-machete/src/dereferenceObject.ts b/packages/json-machete/src/dereferenceObject.ts
index 79d7b46e27c51..b38cbd44f7826 100644
--- a/packages/json-machete/src/dereferenceObject.ts
+++ b/packages/json-machete/src/dereferenceObject.ts
@@ -82,7 +82,7 @@ export async function dereferenceObject(
logger?: any;
resolvedObjects?: WeakSet;
headers?: Record;
- } = {}
+ } = {},
): Promise {
if (obj != null && typeof obj === 'object') {
if (isRefObject(obj)) {
@@ -149,7 +149,7 @@ export async function dereferenceObject(
headers,
root: externalFile,
resolvedObjects,
- }
+ },
);
refMap.set($ref, result);
resolvedObjects.add(result);
diff --git a/packages/json-machete/src/healJSONSchema.ts b/packages/json-machete/src/healJSONSchema.ts
index 8eb77c2c00b20..cde14b43466ec 100644
--- a/packages/json-machete/src/healJSONSchema.ts
+++ b/packages/json-machete/src/healJSONSchema.ts
@@ -45,7 +45,7 @@ export const AnySchema = {
export async function healJSONSchema(
schema: JSONSchema,
- { logger = new DefaultLogger('healJSONSchema') }: { logger?: Logger } = {}
+ { logger = new DefaultLogger('healJSONSchema') }: { logger?: Logger } = {},
): Promise {
const schemaByTitle = new Map();
const anySchemaOneOfInspect = inspect(AnySchema.oneOf);
@@ -54,7 +54,10 @@ export async function healJSONSchema(
{
enter: async function healSubschema(subSchema, { path }) {
if (typeof subSchema === 'object') {
- if (subSchema.title === 'Any' || (subSchema.oneOf && inspect(subSchema.oneOf) === anySchemaOneOfInspect)) {
+ if (
+ subSchema.title === 'Any' ||
+ (subSchema.oneOf && inspect(subSchema.oneOf) === anySchemaOneOfInspect)
+ ) {
return AnySchema;
}
if (subSchema.title) {
@@ -72,10 +75,16 @@ export async function healJSONSchema(
schemaByTitle.set(subSchema.title, subSchema);
}
}
- } else if (Object.keys(subSchema).length === 1 && subSchema.type && !Array.isArray(subSchema.type)) {
+ } else if (
+ Object.keys(subSchema).length === 1 &&
+ subSchema.type &&
+ !Array.isArray(subSchema.type)
+ ) {
return subSchema;
}
- const keys = Object.keys(subSchema).filter(key => key !== 'readOnly' && key !== 'writeOnly');
+ const keys = Object.keys(subSchema).filter(
+ key => key !== 'readOnly' && key !== 'writeOnly',
+ );
if (keys.length === 0) {
logger.debug(`${path} has an empty definition. Adding an object definition.`);
subSchema.type = 'object';
@@ -83,20 +92,26 @@ export async function healJSONSchema(
}
if (typeof subSchema.additionalProperties === 'object') {
const additionalPropertiesKeys = Object.keys(subSchema.additionalProperties).filter(
- key => key !== 'readOnly' && key !== 'writeOnly'
+ key => key !== 'readOnly' && key !== 'writeOnly',
);
if (
additionalPropertiesKeys.length === 0 ||
- (additionalPropertiesKeys.length === 1 && subSchema.additionalProperties.type === 'string')
+ (additionalPropertiesKeys.length === 1 &&
+ subSchema.additionalProperties.type === 'string')
) {
logger.debug(
- `${path} has an empty additionalProperties object. So this is invalid. Replacing it with 'true'`
+ `${path} has an empty additionalProperties object. So this is invalid. Replacing it with 'true'`,
);
subSchema.additionalProperties = true;
}
}
// Really edge case, but we need to support it
- if (subSchema.allOf != null && subSchema.allOf.length === 1 && subSchema.allOf[0].oneOf && subSchema.oneOf) {
+ if (
+ subSchema.allOf != null &&
+ subSchema.allOf.length === 1 &&
+ subSchema.allOf[0].oneOf &&
+ subSchema.oneOf
+ ) {
subSchema.oneOf.push(...subSchema.allOf[0].oneOf);
delete subSchema.allOf;
}
@@ -142,7 +157,9 @@ export async function healJSONSchema(
if (subSchema.description != null) {
subSchema.description = subSchema.description.trim();
if (keys.length === 1) {
- logger.debug(`${path} has a description definition but has nothing else. Adding an object definition.`);
+ logger.debug(
+ `${path} has a description definition but has nothing else. Adding an object definition.`,
+ );
subSchema.type = 'object';
subSchema.additionalProperties = true;
}
@@ -150,23 +167,29 @@ export async function healJSONSchema(
// Some JSON Schemas use this broken pattern and refer the type using `items`
if (subSchema.type === 'object' && subSchema.items) {
logger.debug(
- `${path} has an object definition but with "items" which is not valid. So setting "items" to the actual definition.`
+ `${path} has an object definition but with "items" which is not valid. So setting "items" to the actual definition.`,
);
const realSubschema = subSchema.items;
delete subSchema.items;
subSchema = realSubschema;
}
if (subSchema.properties && subSchema.type !== 'object') {
- logger.debug(`${path} has "properties" with no type defined. Adding a type property with "object" value.`);
+ logger.debug(
+ `${path} has "properties" with no type defined. Adding a type property with "object" value.`,
+ );
subSchema.type = 'object';
}
if (typeof subSchema.example === 'object' && !subSchema.type) {
- logger.debug(`${path} has an example object but no type defined. Setting type to "object".`);
+ logger.debug(
+ `${path} has an example object but no type defined. Setting type to "object".`,
+ );
subSchema.type = 'object';
}
// Items only exist in arrays
if (subSchema.items) {
- logger.debug(`${path} has an items definition but no type defined. Setting type to "array".`);
+ logger.debug(
+ `${path} has an items definition but no type defined. Setting type to "array".`,
+ );
subSchema.type = 'array';
if (subSchema.properties) {
delete subSchema.properties;
@@ -174,11 +197,13 @@ export async function healJSONSchema(
// Items should be an object
if (Array.isArray(subSchema.items)) {
if (subSchema.items.length === 0) {
- logger.debug(`${path} has an items array with a single value. Setting items to an object.`);
+ logger.debug(
+ `${path} has an items array with a single value. Setting items to an object.`,
+ );
subSchema.items = subSchema.items[0];
} else {
logger.debug(
- `${path} has an items array with multiple values. Setting items to an object with oneOf definition.`
+ `${path} has an items array with multiple values. Setting items to an object with oneOf definition.`,
);
subSchema.items = {
oneOf: subSchema.items,
@@ -190,9 +215,14 @@ export async function healJSONSchema(
if (!subSchema.type) {
logger.debug(`${path} has no type defined. Trying to find it.`);
// If required exists without properties
- if (subSchema.required && !subSchema.properties && !subSchema.anyOf && !subSchema.allOf) {
+ if (
+ subSchema.required &&
+ !subSchema.properties &&
+ !subSchema.anyOf &&
+ !subSchema.allOf
+ ) {
logger.debug(
- `${path} has a required definition but no properties or oneOf/allOf. Setting missing properties with Any schema.`
+ `${path} has a required definition but no properties or oneOf/allOf. Setting missing properties with Any schema.`,
);
// Add properties
subSchema.properties = {};
@@ -201,26 +231,36 @@ export async function healJSONSchema(
}
}
// Properties only exist in objects
- if (subSchema.properties || subSchema.patternProperties || 'additionalProperties' in subSchema) {
+ if (
+ subSchema.properties ||
+ subSchema.patternProperties ||
+ 'additionalProperties' in subSchema
+ ) {
logger.debug(
- `${path} has properties or patternProperties or additionalProperties. Setting type to "object".`
+ `${path} has properties or patternProperties or additionalProperties. Setting type to "object".`,
);
subSchema.type = 'object';
}
switch (subSchema.format) {
case 'int64':
case 'int32':
- logger.debug(`${path} has a format of ${subSchema.format}. Setting type to "integer".`);
+ logger.debug(
+ `${path} has a format of ${subSchema.format}. Setting type to "integer".`,
+ );
subSchema.type = 'integer';
break;
case 'float':
case 'double':
- logger.debug(`${path} has a format of ${subSchema.format}. Setting type to "number".`);
+ logger.debug(
+ `${path} has a format of ${subSchema.format}. Setting type to "number".`,
+ );
subSchema.type = 'number';
break;
default:
if (subSchema.format != null) {
- logger.debug(`${path} has a format of ${subSchema.format}. Setting type to "string".`);
+ logger.debug(
+ `${path} has a format of ${subSchema.format}. Setting type to "string".`,
+ );
subSchema.type = 'string';
}
}
@@ -229,12 +269,18 @@ export async function healJSONSchema(
subSchema.type = 'number';
}
}
- if (subSchema.type === 'string' && !subSchema.format && (subSchema.examples || subSchema.example)) {
+ if (
+ subSchema.type === 'string' &&
+ !subSchema.format &&
+ (subSchema.examples || subSchema.example)
+ ) {
const examples = asArray(subSchema.examples || subSchema.example || []);
if (examples?.length) {
const { format } = toJsonSchema(examples[0]);
if (format && format !== 'utc-millisec' && format !== 'style') {
- logger.debug(`${path} has a format of ${format} according to the example. Setting type to "string".`);
+ logger.debug(
+ `${path} has a format of ${format} according to the example. Setting type to "string".`,
+ );
subSchema.format = format;
}
}
@@ -246,16 +292,18 @@ export async function healJSONSchema(
if (subSchema.format) {
if (!JSONSchemaStringFormats.includes(subSchema.format)) {
logger.debug(
- `${path} has a format of ${subSchema.format}. It should be one of ${JSONSchemaStringFormats.join(
- ', '
- )}.`
+ `${path} has a format of ${
+ subSchema.format
+ }. It should be one of ${JSONSchemaStringFormats.join(', ')}.`,
);
delete subSchema.format;
}
}
if (subSchema.required) {
if (!Array.isArray(subSchema.required)) {
- logger.debug(`${path} has a required definition but it is not an array. Removing it.`);
+ logger.debug(
+ `${path} has a required definition but it is not an array. Removing it.`,
+ );
delete subSchema.required;
}
}
@@ -288,7 +336,11 @@ export async function healJSONSchema(
mode: 'first',
},
postProcessFnc(type, schema, value, defaultFunc) {
- if (schema.type === 'object' && !schema.properties && Object.keys(value).length === 0) {
+ if (
+ schema.type === 'object' &&
+ !schema.properties &&
+ Object.keys(value).length === 0
+ ) {
return AnySchema as any;
}
return defaultFunc(type, schema, value);
@@ -297,7 +349,9 @@ export async function healJSONSchema(
subSchema.type = asArray(generatedSchema.type)[0] as any;
subSchema.properties = generatedSchema.properties;
// If type for properties is already given, use it
- logger.debug(`${path} has an example but no type defined. Setting type to ${subSchema.type}.`);
+ logger.debug(
+ `${path} has an example but no type defined. Setting type to ${subSchema.type}.`,
+ );
// if (typeof subSchema.additionalProperties === 'object') {
// for (const propertyName in subSchema.properties) {
// subSchema.properties[propertyName] = subSchema.additionalProperties;
@@ -314,14 +368,21 @@ export async function healJSONSchema(
subSchema.type = 'null';
delete subSchema.const;
}
- if (!subSchema.title && !subSchema.$ref && subSchema.type !== 'array' && !subSchema.items) {
+ if (
+ !subSchema.title &&
+ !subSchema.$ref &&
+ subSchema.type !== 'array' &&
+ !subSchema.items
+ ) {
const realPath = subSchema.$resolvedRef || path;
// Try to get definition name if missing
const splitByDefinitions = realPath.includes('/components/schemas/')
? realPath.split('/components/schemas/')
: realPath.split('/definitions/');
const maybeDefinitionBasedPath =
- splitByDefinitions.length > 1 ? splitByDefinitions[splitByDefinitions.length - 1] : realPath;
+ splitByDefinitions.length > 1
+ ? splitByDefinitions[splitByDefinitions.length - 1]
+ : realPath;
const pathBasedName = maybeDefinitionBasedPath
.split('~1')
.join('/')
@@ -335,9 +396,14 @@ export async function healJSONSchema(
switch (subSchema.type) {
case 'string':
// If it has special pattern, use path based name because it is specific
- if (subSchema.pattern || subSchema.maxLength || subSchema.minLength || subSchema.enum) {
+ if (
+ subSchema.pattern ||
+ subSchema.maxLength ||
+ subSchema.minLength ||
+ subSchema.enum
+ ) {
logger.debug(
- `${path} has a pattern or maxLength or minLength or enum but no title. Setting it to ${pathBasedName}`
+ `${path} has a pattern or maxLength or minLength or enum but no title. Setting it to ${pathBasedName}`,
);
subSchema.title = pathBasedName;
// Otherwise use the format name
@@ -346,7 +412,9 @@ export async function healJSONSchema(
case 'number':
case 'integer':
if (subSchema.enum || subSchema.pattern) {
- logger.debug(`${path} has an enum or pattern but no title. Setting it to ${pathBasedName}`);
+ logger.debug(
+ `${path} has an enum or pattern but no title. Setting it to ${pathBasedName}`,
+ );
subSchema.title = pathBasedName;
// Otherwise use the format name
}
@@ -378,9 +446,13 @@ export async function healJSONSchema(
schemaByTitle.set(subSchema.title, subSchema);
}
}
- if (subSchema.type === 'object' && subSchema.properties && Object.keys(subSchema.properties).length === 0) {
+ if (
+ subSchema.type === 'object' &&
+ subSchema.properties &&
+ Object.keys(subSchema.properties).length === 0
+ ) {
logger.debug(
- `${path} has an empty properties object. Removing it and adding "additionalProperties": true.`
+ `${path} has an empty properties object. Removing it and adding "additionalProperties": true.`,
);
delete subSchema.properties;
subSchema.additionalProperties = true;
@@ -416,6 +488,6 @@ export async function healJSONSchema(
{
visitedSubschemaResultMap: new WeakMap(),
path: '',
- }
+ },
);
}
diff --git a/packages/json-machete/src/referenceJSONSchema.ts b/packages/json-machete/src/referenceJSONSchema.ts
index ec13f4a4393d6..7e8f36a06d221 100644
--- a/packages/json-machete/src/referenceJSONSchema.ts
+++ b/packages/json-machete/src/referenceJSONSchema.ts
@@ -2,7 +2,10 @@ import { JSONSchemaObject } from './types.js';
import { visitJSONSchema } from './visitJSONSchema.js';
import { DefaultLogger } from '@graphql-mesh/utils';
-export async function referenceJSONSchema(schema: JSONSchemaObject, logger = new DefaultLogger('referenceJSONSchema')) {
+export async function referenceJSONSchema(
+ schema: JSONSchemaObject,
+ logger = new DefaultLogger('referenceJSONSchema'),
+) {
const initialDefinitions: Record = {};
const { $ref: initialRef } = await visitJSONSchema(schema, {
enter: (subSchema, { path }) => {
@@ -54,7 +57,7 @@ export async function referenceJSONSchema(schema: JSONSchemaObject, logger = new
}
return subSchema;
},
- }
+ },
);
return {
$ref: initialRef,
diff --git a/packages/json-machete/src/visitJSONSchema.ts b/packages/json-machete/src/visitJSONSchema.ts
index 67cfd2f99bdc8..d1da496a3cee3 100644
--- a/packages/json-machete/src/visitJSONSchema.ts
+++ b/packages/json-machete/src/visitJSONSchema.ts
@@ -5,7 +5,10 @@ export interface JSONSchemaVisitorContext {
path: string;
}
-export type JSONSchemaVisitor = (subSchema: any, context: JSONSchemaVisitorContext) => Promise | any;
+export type JSONSchemaVisitor = (
+ subSchema: any,
+ context: JSONSchemaVisitorContext,
+) => Promise | any;
const identicalFn = (a: T) => a;
@@ -20,7 +23,14 @@ const objectFields = [
'then',
] as const;
-const dictFields = ['anyOf', 'allOf', 'oneOf', 'definitions', 'properties', 'patternProperties'] as const;
+const dictFields = [
+ 'anyOf',
+ 'allOf',
+ 'oneOf',
+ 'definitions',
+ 'properties',
+ 'patternProperties',
+] as const;
export async function visitJSONSchema(
schema: JSONSchema,
@@ -34,7 +44,7 @@ export async function visitJSONSchema(
{ visitedSubschemaResultMap, path }: JSONSchemaVisitorContext = {
visitedSubschemaResultMap: new WeakMap(),
path: '',
- }
+ },
): Promise {
if (typeof schema === 'object') {
if (!visitedSubschemaResultMap.has(schema)) {
@@ -51,7 +61,7 @@ export async function visitJSONSchema(
{
visitedSubschemaResultMap,
path: `${path}/${key}`,
- }
+ },
);
}
}
@@ -62,7 +72,7 @@ export async function visitJSONSchema(
enterResult[key][itemKey] = await visitJSONSchema(
itemValue,
{ enter, leave },
- { visitedSubschemaResultMap, path: `${path}/${key}/${itemKey}` }
+ { visitedSubschemaResultMap, path: `${path}/${key}/${itemKey}` },
);
}
}
@@ -74,7 +84,7 @@ export async function visitJSONSchema(
enterResult.components.schemas[schemaName] = await visitJSONSchema(
subSchema,
{ enter, leave },
- { visitedSubschemaResultMap, path: `${path}/components/schemas/${schemaName}` }
+ { visitedSubschemaResultMap, path: `${path}/components/schemas/${schemaName}` },
);
}
}
diff --git a/packages/json-machete/tests/dereferenceObject.test.ts b/packages/json-machete/tests/dereferenceObject.test.ts
index b945edb7f7e62..639b8d4f1cf48 100644
--- a/packages/json-machete/tests/dereferenceObject.test.ts
+++ b/packages/json-machete/tests/dereferenceObject.test.ts
@@ -60,7 +60,9 @@ describe('dereferenceObject', () => {
expect(result.title).toBe('Container');
expect(result.properties.posts.items.title).toBe('Post');
expect(result.properties.posts.items.properties.author.title).toBe('Author');
- expect(result.properties.posts.items.properties.author === result.properties.authors.items).toBeTruthy();
+ expect(
+ result.properties.posts.items.properties.author === result.properties.authors.items,
+ ).toBeTruthy();
});
it('should dereference external references', async () => {
const result = await dereferenceObject(
@@ -69,7 +71,7 @@ describe('dereferenceObject', () => {
},
{
cwd: __dirname,
- }
+ },
);
expect(result.title).toBe('PostsResponse');
expect(result.properties.items.items.title).toBe('Post');
@@ -242,11 +244,12 @@ describe('dereferenceObject', () => {
},
};
const dereferencedObject = await dereferenceObject(openapiSchema);
- expect(dereferencedObject.paths['/pets/{petId}'].get.responses[200].content['application/json'].schema).toBe(
- openapiSchema.components.schemas.Pet
- );
- expect(dereferencedObject.paths['/pets'].get.responses[200].content['application/json'].schema).toBe(
- openapiSchema.components.schemas.Pets
- );
+ expect(
+ dereferencedObject.paths['/pets/{petId}'].get.responses[200].content['application/json']
+ .schema,
+ ).toBe(openapiSchema.components.schemas.Pet);
+ expect(
+ dereferencedObject.paths['/pets'].get.responses[200].content['application/json'].schema,
+ ).toBe(openapiSchema.components.schemas.Pets);
});
});
diff --git a/packages/loaders/README.md b/packages/loaders/README.md
index 31a375ee5c298..275f9d8a312b3 100644
--- a/packages/loaders/README.md
+++ b/packages/loaders/README.md
@@ -1,12 +1,17 @@
# Omnigraph
-Omnigraph is a set of libraries and tools helps you generate local `GraphQLSchema` instances from different API Schema specifications such as JSON Schema, MySQL, SOAP, OpenAPI and RAML.
+Omnigraph is a set of libraries and tools helps you generate local `GraphQLSchema` instances from
+different API Schema specifications such as JSON Schema, MySQL, SOAP, OpenAPI and RAML.
-You can consume this `GraphQLSchema` inside any tools in GraphQL Ecosystem such as GraphQL Config, GraphQL Code Generator and GraphQL ESLint. You can either bind it to a GraphQL Server like Envelop, Express-GraphQL, GraphQL Helix, Apollo Server or GraphQL Yoga.
+You can consume this `GraphQLSchema` inside any tools in GraphQL Ecosystem such as GraphQL Config,
+GraphQL Code Generator and GraphQL ESLint. You can either bind it to a GraphQL Server like Envelop,
+Express-GraphQL, GraphQL Helix, Apollo Server or GraphQL Yoga.
### GraphQL Config
-GraphQL Config is a way of specifying your GraphQL Project in a standard way so the most of the tools around GraphQL Ecosystem can recognize your project such as VSCode GraphQL Extension, GraphQL ESLint and GraphQL Code Generator
+GraphQL Config is a way of specifying your GraphQL Project in a standard way so the most of the
+tools around GraphQL Ecosystem can recognize your project such as VSCode GraphQL Extension, GraphQL
+ESLint and GraphQL Code Generator
```yaml filename=".graphqlrc.yml"
schema: ./packages/server/modules/**/*.graphql # Backend
@@ -26,7 +31,10 @@ schema:
### GraphQL Code Generator
-Let's say we want to create a type-safe SDK from the generated schema using GraphQL Code Generator and remember GraphQL Code Generator has nothing to do except GraphQL so Omnigraph helps GraphQL Config to consume the nonGraphQL source as GraphQL then it provides the schema and operations to GraphQL Code Generator;
+Let's say we want to create a type-safe SDK from the generated schema using GraphQL Code Generator
+and remember GraphQL Code Generator has nothing to do except GraphQL so Omnigraph helps GraphQL
+Config to consume the nonGraphQL source as GraphQL then it provides the schema and operations to
+GraphQL Code Generator;
Like any other GraphQL project. We can use `extensions.codegen`
@@ -64,9 +72,14 @@ export async function getOmnigraphSDK() {
### Bundling
-As you can see above, Omnigraph is able to download sources via HTTP on runtime. But this has some downsides. The remote API might be down or we might have some bandwidth concerns to avoid. So Omnigraph has "Bundling" feature that helps to store the downloaded and resolved resources once ahead-of-time. But this needs some extra code files with programmatic usage by splitting buildtime and runtime configurations;
+As you can see above, Omnigraph is able to download sources via HTTP on runtime. But this has some
+downsides. The remote API might be down or we might have some bandwidth concerns to avoid. So
+Omnigraph has "Bundling" feature that helps to store the downloaded and resolved resources once
+ahead-of-time. But this needs some extra code files with programmatic usage by splitting buildtime
+and runtime configurations;
-We can create a script called `generate-bundle.ts` and every time we run `npm run generate-bundle` it will download the sources and generate the bundle.
+We can create a script called `generate-bundle.ts` and every time we run `npm run generate-bundle`
+it will download the sources and generate the bundle.
```ts filename="generate-bundle.js"
import { createBundle } from '@omnigraph/openapi'
@@ -121,5 +134,5 @@ schema:
### String interpolation on runtime
You can have dynamic values in `operationHeaders` by using interpolation pattern;
-`{context.apiToken}` or `{env.BASE_URL}`
-In this case, `context` refers to the context you executed your schema with.
+`{context.apiToken}` or `{env.BASE_URL}` In this case, `context` refers to the context you executed
+your schema with.
diff --git a/packages/loaders/json-schema/README.md b/packages/loaders/json-schema/README.md
index 9f7598597f7c3..e02883215c342 100644
--- a/packages/loaders/json-schema/README.md
+++ b/packages/loaders/json-schema/README.md
@@ -1,6 +1,7 @@
## JSON Schema (@omnigraph/json-schema)
-This package generates GraphQL Schema from JSON Schema and sample JSON request and responses. You can define your root field endpoints like below in your GraphQL Config for example;
+This package generates GraphQL Schema from JSON Schema and sample JSON request and responses. You
+can define your root field endpoints like below in your GraphQL Config for example;
```yaml filename=".graphqlrc.yml"
schema:
diff --git a/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts b/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts
index 3ec6909c67c2c..fd669767af9ee 100644
--- a/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts
+++ b/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts
@@ -1,6 +1,15 @@
-import { GraphQLJSON, ObjectTypeComposer, ObjectTypeComposerFieldConfig, SchemaComposer } from 'graphql-compose';
+import {
+ GraphQLJSON,
+ ObjectTypeComposer,
+ ObjectTypeComposerFieldConfig,
+ SchemaComposer,
+} from 'graphql-compose';
import { Logger, MeshFetch, MeshPubSub } from '@graphql-mesh/types';
-import { JSONSchemaLinkConfig, JSONSchemaOperationConfig, OperationHeadersConfiguration } from './types.js';
+import {
+ JSONSchemaLinkConfig,
+ JSONSchemaOperationConfig,
+ OperationHeadersConfiguration,
+} from './types.js';
import { getOperationMetadata, isPubSubOperationConfig, isFileUpload } from './utils.js';
import { createGraphQLError, memoize1 } from '@graphql-tools/utils';
import urlJoin from 'url-join';
@@ -42,7 +51,9 @@ const defaultQsOptions: IStringifyOptions = {
indices: false,
};
-const isListTypeOrNonNullListType = memoize1(function isListTypeOrNonNullListType(type: GraphQLOutputType) {
+const isListTypeOrNonNullListType = memoize1(function isListTypeOrNonNullListType(
+ type: GraphQLOutputType,
+) {
if (isNonNullType(type)) {
return isListType(type.ofType);
}
@@ -55,7 +66,7 @@ function linkResolver(
root: any,
args: any,
context: any,
- info: GraphQLResolveInfo
+ info: GraphQLResolveInfo,
) {
for (const argKey in linkObjArgs) {
const argInterpolation = linkObjArgs[argKey];
@@ -98,7 +109,7 @@ export async function addExecutionLogicToComposer(
pubsub: globalPubsub,
queryParams,
queryStringOptions = {},
- }: AddExecutionLogicToComposerOptions
+ }: AddExecutionLogicToComposerOptions,
) {
logger.debug(`Attaching execution logic to the schema`);
queryStringOptions = { ...defaultQsOptions, ...queryStringOptions };
@@ -112,14 +123,20 @@ export async function addExecutionLogicToComposer(
const field = rootTypeComposer.getField(fieldName);
if (isPubSubOperationConfig(operationConfig)) {
- field.description = operationConfig.description || `PubSub Topic: ${operationConfig.pubsubTopic}`;
+ field.description =
+ operationConfig.description || `PubSub Topic: ${operationConfig.pubsubTopic}`;
field.subscribe = (root, args, context, info) => {
const pubsub = context?.pubsub || globalPubsub;
if (!pubsub) {
- return new GraphQLError(`You should have PubSub defined in either the config or the context!`);
+ return new GraphQLError(
+ `You should have PubSub defined in either the config or the context!`,
+ );
}
const interpolationData = { root, args, context, info, env: process.env };
- let pubsubTopic: string = stringInterpolator.parse(operationConfig.pubsubTopic, interpolationData);
+ let pubsubTopic: string = stringInterpolator.parse(
+ operationConfig.pubsubTopic,
+ interpolationData,
+ );
if (pubsubTopic.startsWith('webhook:')) {
const [, expectedMethod, expectedUrl] = pubsubTopic.split(':');
const expectedPath = new URL(expectedUrl, 'http://localhost').pathname;
@@ -156,7 +173,10 @@ ${operationConfig.description || ''}
const headers: Record = {};
for (const headerName in operationHeadersObj) {
const nonInterpolatedValue = operationHeadersObj[headerName];
- const interpolatedValue = stringInterpolator.parse(nonInterpolatedValue, interpolationData);
+ const interpolatedValue = stringInterpolator.parse(
+ nonInterpolatedValue,
+ interpolationData,
+ );
if (interpolatedValue) {
headers[headerName.toLowerCase()] = interpolatedValue;
}
@@ -164,7 +184,10 @@ ${operationConfig.description || ''}
if (operationConfig?.headers) {
for (const headerName in operationConfig.headers) {
const nonInterpolatedValue = operationConfig.headers[headerName];
- const interpolatedValue = stringInterpolator.parse(nonInterpolatedValue, interpolationData);
+ const interpolatedValue = stringInterpolator.parse(
+ nonInterpolatedValue,
+ interpolationData,
+ );
if (interpolatedValue) {
headers[headerName.toLowerCase()] = interpolatedValue;
}
@@ -187,7 +210,8 @@ ${operationConfig.description || ''}
}
requestInit.body = new Uint8Array(chunks);
- const [, contentType] = Object.entries(headers).find(([key]) => key.toLowerCase() === 'content-type') || [];
+ const [, contentType] =
+ Object.entries(headers).find(([key]) => key.toLowerCase() === 'content-type') || [];
if (!contentType) {
headers['content-type'] = binaryUpload.mimetype;
}
@@ -210,10 +234,11 @@ ${operationConfig.description || ''}
const input = (args.input = resolveDataByUnionInputType(
args.input,
field.args?.input?.type?.getType(),
- schemaComposer
+ schemaComposer,
));
if (input != null) {
- const [, contentType] = Object.entries(headers).find(([key]) => key.toLowerCase() === 'content-type') || [];
+ const [, contentType] =
+ Object.entries(headers).find(([key]) => key.toLowerCase() === 'content-type') || [];
if (contentType?.startsWith('application/x-www-form-urlencoded')) {
requestInit.body = qsStringify(input, queryStringOptions);
} else if (contentType?.startsWith('multipart/form-data')) {
@@ -228,11 +253,15 @@ ${operationConfig.description || ''}
if (inputValue instanceof File) {
formDataValue = inputValue;
} else if (inputValue.name && inputValue instanceof Blob) {
- formDataValue = new File([inputValue], (inputValue as File).name, { type: inputValue.type });
+ formDataValue = new File([inputValue], (inputValue as File).name, {
+ type: inputValue.type,
+ });
} else if (inputValue.arrayBuffer) {
const arrayBuffer = await inputValue.arrayBuffer();
if (inputValue.name) {
- formDataValue = new File([arrayBuffer], inputValue.name, { type: inputValue.type });
+ formDataValue = new File([arrayBuffer], inputValue.name, {
+ type: inputValue.type,
+ });
} else {
formDataValue = new Blob([arrayBuffer], { type: inputValue.type });
}
@@ -263,7 +292,7 @@ ${operationConfig.description || ''}
}
const interpolatedQueryParam = stringInterpolator.parse(
queryParams[queryParamName].toString(),
- interpolationData
+ interpolationData,
);
const queryParamsString = qsStringify(
{
@@ -272,7 +301,7 @@ ${operationConfig.description || ''}
{
...queryStringOptions,
...operationConfig.queryStringOptionsByParam?.[queryParamName],
- }
+ },
);
fullPath += fullPath.includes('?') ? '&' : '?';
fullPath += queryParamsString;
@@ -293,7 +322,10 @@ ${operationConfig.description || ''}
...operationConfig.queryStringOptionsByParam?.[queryParamName],
};
let queryParamObj = argValue;
- if (Array.isArray(argValue) || !(typeof argValue === 'object' && opts.destructObject)) {
+ if (
+ Array.isArray(argValue) ||
+ !(typeof argValue === 'object' && opts.destructObject)
+ ) {
queryParamObj = {
[queryParamName]: argValue,
};
@@ -308,14 +340,17 @@ ${operationConfig.description || ''}
operationLogger.debug(`=> Fetching `, fullPath, `=>`, requestInit);
const fetch: typeof globalFetch = context?.fetch || globalFetch;
if (!fetch) {
- return createGraphQLError(`You should have fetch defined in either the config or the context!`, {
- extensions: {
- request: {
- url: fullPath,
- method: httpMethod,
+ return createGraphQLError(
+ `You should have fetch defined in either the config or the context!`,
+ {
+ extensions: {
+ request: {
+ url: fullPath,
+ method: httpMethod,
+ },
},
},
- });
+ );
}
// Trick to pass `sourceName` to the `fetch` function for tracing
const response = await fetch(fullPath, requestInit, context, {
@@ -378,7 +413,7 @@ ${operationConfig.description || ''}
},
responseText,
},
- }
+ },
);
}
}
@@ -401,7 +436,7 @@ ${operationConfig.description || ''}
},
responseJson,
},
- }
+ },
);
}
}
@@ -411,11 +446,15 @@ ${operationConfig.description || ''}
const isListReturnType = isListTypeOrNonNullListType(field.type.getType());
const isArrayResponse = Array.isArray(responseJson);
if (isListReturnType && !isArrayResponse) {
- operationLogger.debug(`Response is not array but return type is list. Normalizing the response`);
+ operationLogger.debug(
+ `Response is not array but return type is list. Normalizing the response`,
+ );
responseJson = [responseJson];
}
if (!isListReturnType && isArrayResponse) {
- operationLogger.debug(`Response is array but return type is not list. Normalizing the response`);
+ operationLogger.debug(
+ `Response is array but return type is not list. Normalizing the response`,
+ );
responseJson = responseJson[0];
}
@@ -469,7 +508,9 @@ ${operationConfig.description || ''}
return args[prop] || args.input?.[prop] || obj?.[prop];
},
has(_, prop) {
- return prop in args || (args.input && prop in args.input) || obj?.[prop];
+ return (
+ prop in args || (args.input && prop in args.input) || obj?.[prop]
+ );
},
});
case 'header':
@@ -478,7 +519,7 @@ ${operationConfig.description || ''}
return requestInit.body;
}
},
- }
+ },
);
},
},
@@ -501,12 +542,14 @@ ${operationConfig.description || ''}
return args[prop] || args.input?.[prop] || obj?.[prop];
},
has(_, prop) {
- return prop in args || (args.input && prop in args.input) || obj?.[prop];
+ return (
+ prop in args || (args.input && prop in args.input) || obj?.[prop]
+ );
},
});
}
},
- }
+ },
);
},
},
@@ -519,7 +562,10 @@ ${operationConfig.description || ''}
: addResponseMetadata(responseJson);
};
- const handleLinkMap = (linkMap: Record, typeTC: ObjectTypeComposer) => {
+ const handleLinkMap = (
+ linkMap: Record,
+ typeTC: ObjectTypeComposer,
+ ) => {
for (const linkName in linkMap) {
typeTC.addFields({
[linkName]: () => {
@@ -538,7 +584,9 @@ ${operationConfig.description || ''}
} catch {}
}
if (!targetField) {
- logger.debug(`Field ${linkObj.fieldName} not found in ${name} for link ${linkName}`);
+ logger.debug(
+ `Field ${linkObj.fieldName} not found in ${name} for link ${linkName}`,
+ );
}
linkResolverFieldMap[linkName] = (root, args, context, info) =>
linkResolver(linkObj.args, targetField.resolve, root, args, context, info);
@@ -582,7 +630,8 @@ ${operationConfig.description || ''}
if ('responseByStatusCode' in operationConfig) {
const unionOrSingleTC = schemaComposer.getAnyTC(getNamedType(field.type.getType()));
- const types = 'getTypes' in unionOrSingleTC ? unionOrSingleTC.getTypes() : [unionOrSingleTC];
+ const types =
+ 'getTypes' in unionOrSingleTC ? unionOrSingleTC.getTypes() : [unionOrSingleTC];
const statusCodeOneOfIndexMap =
(unionOrSingleTC.getExtension('statusCodeOneOfIndexMap') as Record) || {};
for (const statusCode in operationConfig.responseByStatusCode) {
diff --git a/packages/loaders/json-schema/src/bundle.ts b/packages/loaders/json-schema/src/bundle.ts
index 590d53b15e6cc..a0ece5cf92205 100644
--- a/packages/loaders/json-schema/src/bundle.ts
+++ b/packages/loaders/json-schema/src/bundle.ts
@@ -43,7 +43,7 @@ export async function createBundle(
fetch = crossUndiciFetch,
logger = new DefaultLogger(name),
ignoreErrorResponses = false,
- }: JSONSchemaLoaderBundleOptions
+ }: JSONSchemaLoaderBundleOptions,
): Promise {
logger.debug(`Creating the dereferenced schema from operations config`);
const dereferencedSchema = await getDereferencedJSONSchemaFromOperations({
@@ -102,7 +102,7 @@ export async function getGraphQLSchemaFromBundle(
operationHeaders: additionalOperationHeaders = {},
queryParams,
queryStringOptions,
- }: JSONSchemaLoaderBundleToGraphQLSchemaOptions = {}
+ }: JSONSchemaLoaderBundleToGraphQLSchemaOptions = {},
): Promise {
logger.info(`Dereferencing the bundle`);
const fullyDeferencedSchema = await dereferenceObject(referencedSchema, {
@@ -113,7 +113,10 @@ export async function getGraphQLSchemaFromBundle(
let operationHeaders = {};
if (typeof additionalOperationHeaders === 'function') {
- operationHeaders = async (resolverData: ResolverData, operationConfig: JSONSchemaOperationConfig) => {
+ operationHeaders = async (
+ resolverData: ResolverData,
+ operationConfig: JSONSchemaOperationConfig,
+ ) => {
const result = await additionalOperationHeaders(resolverData, operationConfig);
return {
...bundledOperationHeaders,
diff --git a/packages/loaders/json-schema/src/getGraphQLSchemaFromDereferencedJSONSchema.ts b/packages/loaders/json-schema/src/getGraphQLSchemaFromDereferencedJSONSchema.ts
index c81867869a90c..49a767ac18a1b 100644
--- a/packages/loaders/json-schema/src/getGraphQLSchemaFromDereferencedJSONSchema.ts
+++ b/packages/loaders/json-schema/src/getGraphQLSchemaFromDereferencedJSONSchema.ts
@@ -1,14 +1,17 @@
import { specifiedDirectives } from 'graphql';
import { SchemaComposer } from 'graphql-compose';
import { JSONSchemaObject } from 'json-machete';
-import { addExecutionLogicToComposer, AddExecutionLogicToComposerOptions } from './addExecutionLogicToComposer.js';
+import {
+ addExecutionLogicToComposer,
+ AddExecutionLogicToComposerOptions,
+} from './addExecutionLogicToComposer.js';
import { getComposerFromJSONSchema } from './getComposerFromJSONSchema.js';
export async function getGraphQLSchemaFromDereferencedJSONSchema(
name: string,
opts: Omit & {
fullyDeferencedSchema: JSONSchemaObject;
- }
+ },
) {
const {
fullyDeferencedSchema,
@@ -24,7 +27,7 @@ export async function getGraphQLSchemaFromDereferencedJSONSchema(
logger.debug(`Generating GraphQL Schema from the bundled JSON Schema`);
const visitorResult = await getComposerFromJSONSchema(
fullyDeferencedSchema,
- logger.child('getComposerFromJSONSchema')
+ logger.child('getComposerFromJSONSchema'),
);
const schemaComposerWithoutExecutionLogic = visitorResult.output;
diff --git a/packages/loaders/json-schema/src/getReferencedJSONSchemaFromOperations.ts b/packages/loaders/json-schema/src/getReferencedJSONSchemaFromOperations.ts
index 6086d35bc34cc..6863246e43c9e 100644
--- a/packages/loaders/json-schema/src/getReferencedJSONSchemaFromOperations.ts
+++ b/packages/loaders/json-schema/src/getReferencedJSONSchemaFromOperations.ts
@@ -19,7 +19,7 @@ async function handleOperationResponseConfig(
cwd: string;
fetchFn: WindowOrWorkerGlobalScope['fetch'];
logger?: Logger;
- }
+ },
): Promise {
if (operationResponseConfig.responseSchema) {
const schema =
@@ -95,9 +95,8 @@ export async function getReferencedJSONSchemaFromOperations({
};
for (const operationConfig of operations) {
const { operationType, rootTypeName, fieldName } = getOperationMetadata(operationConfig);
- const rootTypeDefinition = (finalJsonSchema.properties[operationType] = finalJsonSchema.properties[
- operationType
- ] || {
+ const rootTypeDefinition = (finalJsonSchema.properties[operationType] = finalJsonSchema
+ .properties[operationType] || {
type: 'object',
title: rootTypeName,
properties: {},
@@ -132,14 +131,18 @@ export async function getReferencedJSONSchemaFromOperations({
continue;
}
const responseOperationConfig = operationConfig.responseByStatusCode[statusCode];
- const responseOperationSchema = await handleOperationResponseConfig(responseOperationConfig, {
- cwd,
- schemaHeaders,
- fetchFn,
- logger,
- });
+ const responseOperationSchema = await handleOperationResponseConfig(
+ responseOperationConfig,
+ {
+ cwd,
+ schemaHeaders,
+ fetchFn,
+ logger,
+ },
+ );
statusCodeOneOfIndexMap[statusCode] = responseSchemas.length;
- responseOperationSchema.title = responseOperationSchema.title || `${fieldName}_${statusCode}_response`;
+ responseOperationSchema.title =
+ responseOperationSchema.title || `${fieldName}_${statusCode}_response`;
responseSchemas.push(responseOperationSchema);
}
if (responseSchemas.length === 1) {
@@ -161,31 +164,35 @@ export async function getReferencedJSONSchemaFromOperations({
schemaHeaders,
fetchFn,
logger,
- }
+ },
);
}
const rootTypeInputPropertyName = operationType + 'Input';
const rootInputTypeName = rootTypeName + 'Input';
- const rootTypeInputTypeDefinition = (finalJsonSchema.properties[rootTypeInputPropertyName] = finalJsonSchema
- .properties[rootTypeInputPropertyName] || {
- type: 'object',
- title: rootInputTypeName,
- properties: {},
- writeOnly: true,
- });
+ const rootTypeInputTypeDefinition = (finalJsonSchema.properties[rootTypeInputPropertyName] =
+ finalJsonSchema.properties[rootTypeInputPropertyName] || {
+ type: 'object',
+ title: rootInputTypeName,
+ properties: {},
+ writeOnly: true,
+ });
const interpolationKeys: string[] = getInterpolationKeys(...interpolationStrings);
if ('queryParamArgMap' in operationConfig) {
- interpolationKeys.push(...Object.values(operationConfig.queryParamArgMap).map(key => `args.${key}`));
+ interpolationKeys.push(
+ ...Object.values(operationConfig.queryParamArgMap).map(key => `args.${key}`),
+ );
}
for (const interpolationKey of interpolationKeys) {
const interpolationKeyParts = interpolationKey.split('.');
const initialObjectName = interpolationKeyParts.shift();
if (initialObjectName === 'args') {
- rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[fieldName] || {
+ rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[
+ fieldName
+ ] || {
title: `${rootTypeInputPropertyName}_${fieldName}`,
type: 'object',
properties: {},
@@ -213,14 +220,18 @@ export async function getReferencedJSONSchemaFromOperations({
type: 'string',
format: 'binary',
};
- rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[fieldName] || {
+ rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[
+ fieldName
+ ] || {
title: `${rootTypeInputPropertyName}_${fieldName}`,
type: 'object',
properties: {},
};
rootTypeInputTypeDefinition.properties[fieldName].properties.input = generatedSchema;
} else if ('requestSchema' in operationConfig && operationConfig.requestSchema) {
- rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[fieldName] || {
+ rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[
+ fieldName
+ ] || {
title: `${rootTypeInputPropertyName}_${fieldName}`,
type: 'object',
properties: {},
@@ -233,8 +244,10 @@ export async function getReferencedJSONSchemaFromOperations({
}
: operationConfig.requestSchema;
if (operationConfig.requestSample) {
- rootTypeInputTypeDefinition.properties[fieldName].properties.input.examples = rootTypeInputTypeDefinition
- .properties[fieldName].properties.input.examples || [operationConfig.requestSample];
+ rootTypeInputTypeDefinition.properties[fieldName].properties.input.examples =
+ rootTypeInputTypeDefinition.properties[fieldName].properties.input.examples || [
+ operationConfig.requestSample,
+ ];
}
} else if ('requestSample' in operationConfig) {
const sample =
@@ -247,7 +260,9 @@ export async function getReferencedJSONSchemaFromOperations({
logger,
importFn: defaultImportFn,
}).catch((e: any) => {
- throw new Error(`${operationConfig.field}.requestSample: ${operationConfig.requestSample}; ${e.message}`);
+ throw new Error(
+ `${operationConfig.field}.requestSample: ${operationConfig.requestSample}; ${e.message}`,
+ );
});
const generatedSchema = toJsonSchema(sample, {
required: false,
@@ -263,7 +278,9 @@ export async function getReferencedJSONSchemaFromOperations({
});
generatedSchema.title = operationConfig.requestTypeName;
generatedSchema.examples = [sample];
- rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[fieldName] || {
+ rootTypeInputTypeDefinition.properties[fieldName] = rootTypeInputTypeDefinition.properties[
+ fieldName
+ ] || {
title: `${rootTypeInputPropertyName}_${fieldName}`,
type: 'object',
properties: {},
diff --git a/packages/loaders/json-schema/src/getTypeResolverFromOutputTCs.ts b/packages/loaders/json-schema/src/getTypeResolverFromOutputTCs.ts
index 5f97534c0111d..413fd9001e1d8 100644
--- a/packages/loaders/json-schema/src/getTypeResolverFromOutputTCs.ts
+++ b/packages/loaders/json-schema/src/getTypeResolverFromOutputTCs.ts
@@ -9,11 +9,14 @@ export function getTypeResolverFromOutputTCs(
ajv: Ajv,
outputTypeComposers: (ObjectTypeComposer | UnionTypeComposer)[],
subSchemaAndTypeComposers: JSONSchemaObject & TypeComposers,
- statusCodeOneOfIndexMap?: Record
+ statusCodeOneOfIndexMap?: Record,
): GraphQLTypeResolver {
const statusCodeTypeMap = new Map();
for (const statusCode in statusCodeOneOfIndexMap) {
- statusCodeTypeMap.set(statusCode.toString(), outputTypeComposers[statusCodeOneOfIndexMap[statusCode]]);
+ statusCodeTypeMap.set(
+ statusCode.toString(),
+ outputTypeComposers[statusCodeOneOfIndexMap[statusCode]],
+ );
}
const discriminatorField = subSchemaAndTypeComposers.discriminator?.propertyName;
return function resolveType(data: any, context: any, info: GraphQLResolveInfo) {
@@ -23,7 +26,8 @@ export function getTypeResolverFromOutputTCs(
return data[discriminatorField];
}
if (data.$statusCode && statusCodeOneOfIndexMap) {
- const type = statusCodeTypeMap.get(data.$statusCode.toString()) || statusCodeTypeMap.get('default');
+ const type =
+ statusCodeTypeMap.get(data.$statusCode.toString()) || statusCodeTypeMap.get('default');
if (type) {
if ('getFields' in type) {
return type.getTypeName();
@@ -40,7 +44,7 @@ export function getTypeResolverFromOutputTCs(
.filter(property => !property.toString().startsWith('$'))
: null;
const allOutputTypeComposers = outputTypeComposers.flatMap(typeComposer =>
- 'getFields' in typeComposer ? typeComposer : typeComposer.getTypeComposers()
+ 'getFields' in typeComposer ? typeComposer : typeComposer.getTypeComposers(),
);
for (const outputTypeComposer of allOutputTypeComposers) {
const typeName = outputTypeComposer.getTypeName();
@@ -53,7 +57,9 @@ export function getTypeResolverFromOutputTCs(
return typeName;
}
} else {
- const validateFn = outputTypeComposer.getExtension('validateWithJSONSchema') as ValidateFunction;
+ const validateFn = outputTypeComposer.getExtension(
+ 'validateWithJSONSchema',
+ ) as ValidateFunction;
if (validateFn) {
const isValid = validateFn(data);
if (isValid) {
@@ -79,9 +85,17 @@ export function getTypeResolverFromOutputTCs(
});
return error;
}
- const error = new GraphQLError(`Received data doesn't met the union`, null, null, null, null, null, {
- validationErrors,
- });
+ const error = new GraphQLError(
+ `Received data doesn't met the union`,
+ null,
+ null,
+ null,
+ null,
+ null,
+ {
+ validationErrors,
+ },
+ );
return error;
};
}
diff --git a/packages/loaders/json-schema/src/getUnionTypeComposers.ts b/packages/loaders/json-schema/src/getUnionTypeComposers.ts
index f7bd74bb073ba..2075364e15e4b 100644
--- a/packages/loaders/json-schema/src/getUnionTypeComposers.ts
+++ b/packages/loaders/json-schema/src/getUnionTypeComposers.ts
@@ -20,7 +20,10 @@ const ONE_OF_DEFINITION = /* GraphQL */ `
export interface GetUnionTypeComposersOpts {
schemaComposer: SchemaComposer;
ajv: Ajv;
- typeComposersList: { input?: AnyTypeComposer; output?: ObjectTypeComposer | UnionTypeComposer }[];
+ typeComposersList: {
+ input?: AnyTypeComposer;
+ output?: ObjectTypeComposer | UnionTypeComposer;
+ }[];
subSchemaAndTypeComposers: JSONSchemaObject & TypeComposers;
logger: Logger;
}
@@ -33,7 +36,7 @@ export function getContainerTC(schemaComposer: SchemaComposer, output: ComposeIn
type: output as any,
resolve: root => root,
},
- })
+ }),
);
}
@@ -84,7 +87,9 @@ export function getUnionTypeComposers({
ajv,
outputTypeComposers,
subSchemaAndTypeComposers,
- (subSchemaAndTypeComposers.output as UnionTypeComposer).getExtension('statusCodeOneOfIndexMap') as any
+ (subSchemaAndTypeComposers.output as UnionTypeComposer).getExtension(
+ 'statusCodeOneOfIndexMap',
+ ) as any,
);
(subSchemaAndTypeComposers.output as UnionTypeComposer).setResolveType(resolveType);
diff --git a/packages/loaders/json-schema/src/getValidTypeName.ts b/packages/loaders/json-schema/src/getValidTypeName.ts
index 6c958dd01f9f1..e83d78f2977c3 100644
--- a/packages/loaders/json-schema/src/getValidTypeName.ts
+++ b/packages/loaders/json-schema/src/getValidTypeName.ts
@@ -15,7 +15,9 @@ export function getValidTypeName({
if (!subSchema.title) {
throw new Error('Missing title for schema; ' + inspect(subSchema));
}
- const sanitizedName = sanitizeNameForGraphQL(isInput ? subSchema.title + '_Input' : subSchema.title);
+ const sanitizedName = sanitizeNameForGraphQL(
+ isInput ? subSchema.title + '_Input' : subSchema.title,
+ );
if (schemaComposer.has(sanitizedName)) {
let i = 2;
while (schemaComposer.has(sanitizedName + i)) {
diff --git a/packages/loaders/json-schema/src/loadGraphQLSchemaFromJSONSchemas.ts b/packages/loaders/json-schema/src/loadGraphQLSchemaFromJSONSchemas.ts
index 8839f3acf5bc3..f7c2eb8fe96ed 100644
--- a/packages/loaders/json-schema/src/loadGraphQLSchemaFromJSONSchemas.ts
+++ b/packages/loaders/json-schema/src/loadGraphQLSchemaFromJSONSchemas.ts
@@ -3,7 +3,10 @@ import { getDereferencedJSONSchemaFromOperations } from './getDereferencedJSONSc
import { getGraphQLSchemaFromDereferencedJSONSchema } from './getGraphQLSchemaFromDereferencedJSONSchema.js';
import { JSONSchemaLoaderOptions } from './types.js';
-export async function loadGraphQLSchemaFromJSONSchemas(name: string, options: JSONSchemaLoaderOptions) {
+export async function loadGraphQLSchemaFromJSONSchemas(
+ name: string,
+ options: JSONSchemaLoaderOptions,
+) {
const logger = options.logger || new DefaultLogger(name);
const operations = options.operations;
const cwd = options.cwd || process.cwd();
diff --git a/packages/loaders/json-schema/src/resolveDataByUnionInputType.ts b/packages/loaders/json-schema/src/resolveDataByUnionInputType.ts
index 25eb24a4ae866..23b0b6590b671 100644
--- a/packages/loaders/json-schema/src/resolveDataByUnionInputType.ts
+++ b/packages/loaders/json-schema/src/resolveDataByUnionInputType.ts
@@ -3,10 +3,16 @@ import { asArray } from '@graphql-tools/utils';
import { SchemaComposer } from 'graphql-compose';
import { sanitizeNameForGraphQL } from '@graphql-mesh/utils';
-export function resolveDataByUnionInputType(data: any, type: GraphQLInputType, schemaComposer: SchemaComposer): any {
+export function resolveDataByUnionInputType(
+ data: any,
+ type: GraphQLInputType,
+ schemaComposer: SchemaComposer,
+): any {
if (data) {
if (isListType(type)) {
- return asArray(data).map(elem => resolveDataByUnionInputType(elem, type.ofType, schemaComposer));
+ return asArray(data).map(elem =>
+ resolveDataByUnionInputType(elem, type.ofType, schemaComposer),
+ );
}
if (isNonNullType(type)) {
return resolveDataByUnionInputType(data, type.ofType, schemaComposer);
@@ -20,7 +26,11 @@ export function resolveDataByUnionInputType(data: any, type: GraphQLInputType, s
const field = fieldMap[fieldName];
if (field) {
if (isOneOf) {
- const resolvedData = resolveDataByUnionInputType(data[fieldName], field.type, schemaComposer);
+ const resolvedData = resolveDataByUnionInputType(
+ data[fieldName],
+ field.type,
+ schemaComposer,
+ );
return resolvedData;
}
const fieldData = data[fieldName];
diff --git a/packages/loaders/json-schema/src/types.ts b/packages/loaders/json-schema/src/types.ts
index 9fc26140e61a6..da534b29e478d 100644
--- a/packages/loaders/json-schema/src/types.ts
+++ b/packages/loaders/json-schema/src/types.ts
@@ -52,7 +52,16 @@ export type JSONSchemaBaseOperationConfigWithJSONRequest = JSONSchemaBaseOperati
requestBaseBody?: any;
};
-export type HTTPMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+export type HTTPMethod =
+ | 'GET'
+ | 'HEAD'
+ | 'POST'
+ | 'PUT'
+ | 'DELETE'
+ | 'CONNECT'
+ | 'OPTIONS'
+ | 'TRACE'
+ | 'PATCH';
export type JSONSchemaHTTPBaseOperationConfig = JSONSchemaBaseOperationConfig & {
path: string;
@@ -84,4 +93,7 @@ export type JSONSchemaOperationConfig =
export type OperationHeadersConfiguration =
| Record
- | ((data: ResolverData, operationConfig: JSONSchemaOperationConfig) => PromiseOrValue>);
+ | ((
+ data: ResolverData,
+ operationConfig: JSONSchemaOperationConfig,
+ ) => PromiseOrValue>);
diff --git a/packages/loaders/json-schema/src/utils.ts b/packages/loaders/json-schema/src/utils.ts
index 82bde1c7d749a..22f3d5ecde213 100644
--- a/packages/loaders/json-schema/src/utils.ts
+++ b/packages/loaders/json-schema/src/utils.ts
@@ -2,7 +2,7 @@ import { OperationTypeNode } from 'graphql';
import { JSONSchemaOperationConfig, JSONSchemaPubSubOperationConfig, HTTPMethod } from './types.js';
export function isPubSubOperationConfig(
- operationConfig: JSONSchemaOperationConfig
+ operationConfig: JSONSchemaOperationConfig,
): operationConfig is JSONSchemaPubSubOperationConfig {
return 'pubsubTopic' in operationConfig;
}
@@ -55,7 +55,9 @@ export function cleanObject(obj: any) {
return obj;
}
-export function isFileUpload(obj: any): obj is { createReadStream: () => AsyncIterable; mimetype: string } {
+export function isFileUpload(
+ obj: any,
+): obj is { createReadStream: () => AsyncIterable; mimetype: string } {
return typeof obj.createReadStream === 'function';
}
diff --git a/packages/loaders/json-schema/test/execution.test.ts b/packages/loaders/json-schema/test/execution.test.ts
index e8d2f8f35a12a..566531466b059 100644
--- a/packages/loaders/json-schema/test/execution.test.ts
+++ b/packages/loaders/json-schema/test/execution.test.ts
@@ -98,7 +98,7 @@ describe('Execution', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
baseUrl: 'http://localhost:3000',
@@ -161,7 +161,7 @@ describe('Execution', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
baseUrl: 'http://localhost:3000',
@@ -205,7 +205,9 @@ describe('Execution', () => {
expect(result).toEqual({
data: {
test: {
- url: `http://localhost:3000/test?foo${encodeURIComponent('[0]')}=bar&foo${encodeURIComponent('[1]')}=baz`,
+ url: `http://localhost:3000/test?foo${encodeURIComponent(
+ '[0]',
+ )}=bar&foo${encodeURIComponent('[1]')}=baz`,
},
},
});
@@ -227,7 +229,7 @@ describe('Execution', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
baseUrl: 'http://localhost:3000',
@@ -271,7 +273,9 @@ describe('Execution', () => {
expect(result).toEqual({
data: {
test: {
- url: `http://localhost:3000/test?foo${encodeURIComponent('[]')}=bar&foo${encodeURIComponent('[]')}=baz`,
+ url: `http://localhost:3000/test?foo${encodeURIComponent(
+ '[]',
+ )}=bar&foo${encodeURIComponent('[]')}=baz`,
},
},
});
@@ -293,7 +297,7 @@ describe('Execution', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
baseUrl: 'http://localhost:3000',
@@ -361,7 +365,7 @@ describe('Execution', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
baseUrl: 'http://localhost:3000',
diff --git a/packages/loaders/json-schema/test/getComposerFromSchema.test.ts b/packages/loaders/json-schema/test/getComposerFromSchema.test.ts
index 2e1938eafbc59..972ec5127b9be 100644
--- a/packages/loaders/json-schema/test/getComposerFromSchema.test.ts
+++ b/packages/loaders/json-schema/test/getComposerFromSchema.test.ts
@@ -97,7 +97,7 @@ enum ExampleEnum {
foo
bar
qux
-}`.trim()
+}`.trim(),
);
});
it('should generate a new enum type from enum schema by sanitizing enum keys', async () => {
@@ -211,7 +211,7 @@ enum AdminPermission {
expect(
unionComposer.toSDL({
deep: true,
- })
+ }),
).toBe(outputSchema);
});
it('should generate an input union type for oneOf definitions that contain scalar types', async () => {
@@ -237,7 +237,7 @@ enum AdminPermission {
expect(
(result.input as InputTypeComposer).toSDL({
deep: true,
- })
+ }),
).toBe(
/* GraphQL */ `
input ExampleOneOf_Input @oneOf {
@@ -250,7 +250,7 @@ ${printType(GraphQLString)}
input ExampleObject_Input {
id: String
}
- `.trim()
+ `.trim(),
);
});
it('should generate merged object types from allOf definitions', async () => {
@@ -286,7 +286,7 @@ input ExampleAllOf_Input {
id: String!
name: String!
}
- `.trim()
+ `.trim(),
);
expect((result.output as InputTypeComposer).toSDL()).toBe(
/* GraphQL */ `
@@ -294,7 +294,7 @@ type ExampleAllOf {
id: String!
name: String!
}
- `.trim()
+ `.trim(),
);
});
it('should generate container types and fields for allOf definitions that contain scalar types', async () => {
@@ -356,7 +356,7 @@ input ExampleAnyOf_Input {
id: String!
name: String!
}
- `.trim()
+ `.trim(),
);
expect((result.output as InputTypeComposer).toSDL()).toBe(
/* GraphQL */ `
@@ -364,7 +364,7 @@ type ExampleAnyOf {
id: String!
name: String!
}
- `.trim()
+ `.trim(),
);
});
it('should generate container types and fields for anyOf definitions that contain scalar types', async () => {
@@ -631,7 +631,7 @@ type ExampleAnyOf {
expect(
(result.output as ObjectTypeComposer).toSDL({
deep: true,
- })
+ }),
).toBe(
/* GraphQL */ `
type ExampleObject {
@@ -649,7 +649,7 @@ ${printType(GraphQLString)}
type Bar {
name: String
}
-`.trim()
+`.trim(),
);
});
it('should create correct object types from object definition', async () => {
@@ -669,14 +669,14 @@ type Bar {
input ExampleObject_Input {
id: String
}
- `.trim()
+ `.trim(),
);
expect((result.output as InputTypeComposer).toSDL()).toBe(
/* GraphQL */ `
type ExampleObject {
id: String
}
- `.trim()
+ `.trim(),
);
});
it('should return GraphQLSchema if object definition given with _schema title', async () => {
@@ -702,7 +702,7 @@ type ExampleObject {
type Query {
foo: String
}
- `.trim()
+ `.trim(),
);
});
it('should return Query type if object definition given with Query title', async () => {
@@ -722,7 +722,7 @@ type Query {
type Query {
foo: String
}
- `.trim()
+ `.trim(),
);
});
it('should return Mutation type if object definition given with Query title', async () => {
@@ -742,7 +742,7 @@ type Query {
type Mutation {
foo: String
}
- `.trim()
+ `.trim(),
);
});
it('should return Subscription type if object definition given with Subscription title', async () => {
@@ -762,7 +762,7 @@ type Mutation {
type Subscription_ {
foo: String
}
- `.trim()
+ `.trim(),
);
});
it('should add arguments to Query fields with the object definition QueryTitle', async () => {
@@ -805,7 +805,7 @@ type Query {
}
${printType(GraphQLString)}
- `.trim()
+ `.trim(),
);
});
it('should choose correct type in union type generated from oneOf', async () => {
diff --git a/packages/loaders/openapi/src/bundle.ts b/packages/loaders/openapi/src/bundle.ts
index e2fa54e7f84e6..fca6ba2217285 100644
--- a/packages/loaders/openapi/src/bundle.ts
+++ b/packages/loaders/openapi/src/bundle.ts
@@ -12,7 +12,7 @@ import { OpenAPILoaderOptions } from './types.js';
*/
export async function createBundle(
name: string,
- openApiLoaderOptions: OpenAPILoaderOptions
+ openApiLoaderOptions: OpenAPILoaderOptions,
): Promise {
const { operations, baseUrl, cwd, fetch, schemaHeaders, operationHeaders } =
await getJSONSchemaOptionsFromOpenAPIOptions(name, openApiLoaderOptions);
diff --git a/packages/loaders/openapi/src/getJSONSchemaOptionsFromOpenAPIOptions.ts b/packages/loaders/openapi/src/getJSONSchemaOptionsFromOpenAPIOptions.ts
index 0b6686f4be424..cbb8896bb34af 100644
--- a/packages/loaders/openapi/src/getJSONSchemaOptionsFromOpenAPIOptions.ts
+++ b/packages/loaders/openapi/src/getJSONSchemaOptionsFromOpenAPIOptions.ts
@@ -1,5 +1,15 @@
-import { defaultImportFn, DefaultLogger, readFileOrUrl, sanitizeNameForGraphQL } from '@graphql-mesh/utils';
-import { JSONSchemaObject, dereferenceObject, resolvePath, handleUntitledDefinitions } from 'json-machete';
+import {
+ defaultImportFn,
+ DefaultLogger,
+ readFileOrUrl,
+ sanitizeNameForGraphQL,
+} from '@graphql-mesh/utils';
+import {
+ JSONSchemaObject,
+ dereferenceObject,
+ resolvePath,
+ handleUntitledDefinitions,
+} from 'json-machete';
import { OpenAPIV3, OpenAPIV2 } from 'openapi-types';
import {
HTTPMethod,
@@ -42,9 +52,10 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
queryParams = {},
selectQueryOrMutationField = [],
logger = new DefaultLogger('getJSONSchemaOptionsFromOpenAPIOptions'),
- }: GetJSONSchemaOptionsFromOpenAPIOptionsParams
+ }: GetJSONSchemaOptionsFromOpenAPIOptionsParams,
) {
- const fieldTypeMap: Record = {};
+ const fieldTypeMap: Record =
+ {};
for (const { fieldName, type } of selectQueryOrMutationField) {
fieldTypeMap[fieldName] = type;
}
@@ -81,7 +92,10 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
baseOperationArgTypeMap = baseOperationArgTypeMap || {};
baseOperationArgTypeMap[variableName] = variable as JSONSchemaObject;
if (variable.default) {
- baseUrl = baseUrl.replace(`{args.${variableName}}`, `{args.${variableName}:${variable.default}}`);
+ baseUrl = baseUrl.replace(
+ `{args.${variableName}}`,
+ `{args.${variableName}:${variable.default}}`,
+ );
}
}
}
@@ -99,7 +113,10 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
responseByStatusCode: Record;
};
- const methodObjFieldMap = new WeakMap();
+ const methodObjFieldMap = new WeakMap<
+ OpenAPIV2.OperationObject | OpenAPIV3.OperationObject,
+ OperationConfig
+ >();
for (const relativePath in oasOrSwagger.paths) {
const pathObj = oasOrSwagger.paths[relativePath];
@@ -138,12 +155,12 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
};
}
for (const paramObjIndex in allParams) {
- const paramObj = allParams[paramObjIndex] as OpenAPIV2.ParameterObject | OpenAPIV3.ParameterObject;
+ const paramObj = allParams[paramObjIndex] as
+ | OpenAPIV2.ParameterObject
+ | OpenAPIV3.ParameterObject;
const argName = sanitizeNameForGraphQL(paramObj.name);
- const operationArgTypeMap = (operationConfig.argTypeMap = operationConfig.argTypeMap || {}) as Record<
- string,
- JSONSchemaObject
- >;
+ const operationArgTypeMap = (operationConfig.argTypeMap =
+ operationConfig.argTypeMap || {}) as Record;
switch (paramObj.in) {
case 'query':
@@ -159,7 +176,8 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
}
}
if ('explode' in paramObj) {
- operationConfig.queryStringOptionsByParam = operationConfig.queryStringOptionsByParam || {};
+ operationConfig.queryStringOptionsByParam =
+ operationConfig.queryStringOptionsByParam || {};
operationConfig.queryStringOptionsByParam[paramObj.name] =
operationConfig.queryStringOptionsByParam[paramObj.name] || {};
if (paramObj.explode) {
@@ -169,14 +187,19 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
if (paramObj.style === 'form') {
operationConfig.queryStringOptionsByParam[paramObj.name].arrayFormat = 'comma';
} else {
- logger.warn(`Other styles including ${paramObj.style} of query parameters are not supported yet.`);
+ logger.warn(
+ `Other styles including ${paramObj.style} of query parameters are not supported yet.`,
+ );
}
}
}
break;
case 'path': {
// If it is in the path, let JSON Schema handler put it
- operationConfig.path = operationConfig.path.replace(`{${paramObj.name}}`, `{args.${argName}}`);
+ operationConfig.path = operationConfig.path.replace(
+ `{${paramObj.name}}`,
+ `{args.${argName}}`,
+ );
break;
}
case 'header': {
@@ -234,7 +257,8 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
break;
}
- operationArgTypeMap[argName] = paramObj.schema || paramObj.content?.['application/json']?.schema || paramObj;
+ operationArgTypeMap[argName] =
+ paramObj.schema || paramObj.content?.['application/json']?.schema || paramObj;
if (!operationArgTypeMap[argName].title) {
operationArgTypeMap[argName].name = paramObj.name;
}
@@ -244,7 +268,13 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
if (paramObj.required) {
operationArgTypeMap[argName].nullable = false;
}
- if (!('type' in paramObj) && !paramObj.schema && !paramObj.content && !paramObj.example && !paramObj.examples) {
+ if (
+ !('type' in paramObj) &&
+ !paramObj.schema &&
+ !paramObj.content &&
+ !paramObj.example &&
+ !paramObj.examples
+ ) {
operationArgTypeMap[argName].type = 'string';
}
}
@@ -272,7 +302,9 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
// Handling multiple response types
for (const responseKey in methodObj.responses) {
- const responseObj = methodObj.responses[responseKey] as OpenAPIV3.ResponseObject | OpenAPIV2.ResponseObject;
+ const responseObj = methodObj.responses[responseKey] as
+ | OpenAPIV3.ResponseObject
+ | OpenAPIV2.ResponseObject;
let schemaObj: JSONSchemaObject;
@@ -303,17 +335,24 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
if (allMimeTypes.length === 0) {
allMimeTypes = Object.keys(responseObj.content) as string[];
}
- const jsonLikeMimeTypes = allMimeTypes.filter(c => c !== '*/*' && c.toString().includes('json'));
+ const jsonLikeMimeTypes = allMimeTypes.filter(
+ c => c !== '*/*' && c.toString().includes('json'),
+ );
const mimeTypes = jsonLikeMimeTypes.length > 0 ? jsonLikeMimeTypes : allMimeTypes;
// If we have a better accept header, overwrite User's choice
- if ((!operationConfig.headers?.accept && !operationConfig.headers?.Accept) || mimeTypes.length === 1) {
+ if (
+ (!operationConfig.headers?.accept && !operationConfig.headers?.Accept) ||
+ mimeTypes.length === 1
+ ) {
operationConfig.headers = operationConfig.headers || {};
if (operationConfig.headers.Accept) {
delete operationConfig.headers.Accept;
}
operationConfig.headers.accept =
- jsonLikeMimeTypes.length > 0 ? jsonLikeMimeTypes.join(',') : allMimeTypes[0].toString();
+ jsonLikeMimeTypes.length > 0
+ ? jsonLikeMimeTypes.join(',')
+ : allMimeTypes[0].toString();
}
for (const contentKey in responseObj.content) {
@@ -398,7 +437,7 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
fetchFn,
logger,
headers: schemaHeaders,
- }
+ },
);
responseByStatusCode[responseKey].links = responseByStatusCode[responseKey].links || {};
for (const linkName in dereferencedLinkObj.links) {
@@ -423,7 +462,7 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
const [externalPath, ref] = linkObj.operationRef.split('#');
if (externalPath) {
logger.debug(
- `Skipping external operation reference ${linkObj.operationRef}\n Use additionalTypeDefs and additionalResolvers instead.`
+ `Skipping external operation reference ${linkObj.operationRef}\n Use additionalTypeDefs and additionalResolvers instead.`,
);
} else {
const actualOperation = resolvePath(ref, oasOrSwagger);
@@ -447,13 +486,20 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
}
if (!operationConfig.field) {
- methodObj.operationId = getFieldNameFromPath(relativePath, method, schemaObj?.$resolvedRef);
+ methodObj.operationId = getFieldNameFromPath(
+ relativePath,
+ method,
+ schemaObj?.$resolvedRef,
+ );
// Operation ID might not be avaiable so let's generate field name from path and response type schema
operationConfig.field = sanitizeNameForGraphQL(methodObj.operationId);
}
// Give a better name to the request input object
- if (typeof operationConfig.requestSchema === 'object' && !operationConfig.requestSchema.title) {
+ if (
+ typeof operationConfig.requestSchema === 'object' &&
+ !operationConfig.requestSchema.title
+ ) {
operationConfig.requestSchema.title = operationConfig.field + '_request';
}
}
@@ -482,11 +528,15 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
const callbackOperation: OpenAPIV3.OperationObject = callbackUrlObj[method];
callbackOperationConfig.pubsubTopic = `webhook:${method}:${pubsubTopicSuffix}`;
callbackOperationConfig.field = callbackOperation.operationId;
- callbackOperationConfig.description = callbackOperation.description || callbackOperation.summary;
- const requestBodyContents = (callbackOperation.requestBody as OpenAPIV3.RequestBodyObject)?.content;
+ callbackOperationConfig.description =
+ callbackOperation.description || callbackOperation.summary;
+ const requestBodyContents = (
+ callbackOperation.requestBody as OpenAPIV3.RequestBodyObject
+ )?.content;
if (requestBodyContents) {
- callbackOperationConfig.responseSchema = requestBodyContents[Object.keys(requestBodyContents)[0]]
- .schema as any;
+ callbackOperationConfig.responseSchema = requestBodyContents[
+ Object.keys(requestBodyContents)[0]
+ ].schema as any;
}
const responses = callbackOperation.responses;
if (responses) {
@@ -494,13 +544,15 @@ export async function getJSONSchemaOptionsFromOpenAPIOptions(
if (response) {
const responseContents = (response as OpenAPIV3.ResponseObject).content;
if (responseContents) {
- callbackOperationConfig.requestSchema = responseContents[Object.keys(responseContents)[0]]
- .schema as any;
+ callbackOperationConfig.requestSchema = responseContents[
+ Object.keys(responseContents)[0]
+ ].schema as any;
}
}
}
}
- callbackOperationConfig.field = callbackOperationConfig.field || sanitizeNameForGraphQL(callbackKey);
+ callbackOperationConfig.field =
+ callbackOperationConfig.field || sanitizeNameForGraphQL(callbackKey);
operations.push(callbackOperationConfig);
}
}
diff --git a/packages/loaders/openapi/src/utils.ts b/packages/loaders/openapi/src/utils.ts
index 3d0b97c71a302..719a9d4b55e32 100644
--- a/packages/loaders/openapi/src/utils.ts
+++ b/packages/loaders/openapi/src/utils.ts
@@ -11,7 +11,10 @@ export function getFieldNameFromPath(path: string, method: string, responseTypeS
let fieldNameWithoutMethod = actualParts.join('_');
// If path doesn't give any field name without identifiers, we can use the return type with HTTP Method name
- if ((!fieldNameWithoutMethod || fieldNameWithoutMethod.startsWith('by')) && responseTypeSchemaRef) {
+ if (
+ (!fieldNameWithoutMethod || fieldNameWithoutMethod.startsWith('by')) &&
+ responseTypeSchemaRef
+ ) {
const refArr = responseTypeSchemaRef.split('/');
// lowercase looks better in the schema
const prefix = camelCase(refArr[refArr.length - 1]);
diff --git a/packages/loaders/openapi/tests/basket.test.ts b/packages/loaders/openapi/tests/basket.test.ts
index 4016ad6134ac9..c1fa3fb831f37 100644
--- a/packages/loaders/openapi/tests/basket.test.ts
+++ b/packages/loaders/openapi/tests/basket.test.ts
@@ -33,7 +33,7 @@ describe('Basket', () => {
return new Response(
JSON.stringify({
random: 2,
- })
+ }),
);
},
});
diff --git a/packages/loaders/openapi/tests/calendly.test.ts b/packages/loaders/openapi/tests/calendly.test.ts
index 9511c593a1d1e..f9c8d09e75f7b 100644
--- a/packages/loaders/openapi/tests/calendly.test.ts
+++ b/packages/loaders/openapi/tests/calendly.test.ts
@@ -26,7 +26,7 @@ describe('Calendly', () => {
text: () => Promise.resolve(''),
ok: true,
- } as Response)
+ } as Response),
);
const createdSchema = await loadGraphQLSchemaFromOpenAPI('calendly', {
source: './fixtures/calendly.yml',
@@ -35,7 +35,7 @@ describe('Calendly', () => {
});
return graphql({ schema: createdSchema, source: query }).then((result: any) => {
expect((fetch.mock.calls[0] as string[])[0]).toEqual(
- 'https://api.calendly.com/scheduled_events?organization=http%3A%2F%2Fa%2F&count=20'
+ 'https://api.calendly.com/scheduled_events?organization=http%3A%2F%2Fa%2F&count=20',
);
});
});
@@ -54,7 +54,7 @@ describe('Calendly', () => {
text: () => Promise.resolve(''),
ok: true,
- } as Response)
+ } as Response),
);
const createdSchema = await loadGraphQLSchemaFromOpenAPI('calendly', {
source: './fixtures/calendly.yml',
@@ -64,7 +64,7 @@ describe('Calendly', () => {
return graphql({ schema: createdSchema, source: query }).then((result: any) => {
expect((fetch.mock.calls[0] as string[])[0]).toEqual(
- 'https://api.calendly.com/scheduled_events?invitee_email=a%40b.com&count=20'
+ 'https://api.calendly.com/scheduled_events?invitee_email=a%40b.com&count=20',
);
});
});
diff --git a/packages/loaders/openapi/tests/example_api.test.ts b/packages/loaders/openapi/tests/example_api.test.ts
index de9e07952de8c..0f000d160908a 100644
--- a/packages/loaders/openapi/tests/example_api.test.ts
+++ b/packages/loaders/openapi/tests/example_api.test.ts
@@ -1,5 +1,13 @@
/* eslint-disable import/no-nodejs-modules */
-import { execute, graphql, GraphQLInputObjectType, GraphQLObjectType, GraphQLSchema, parse, validate } from 'graphql';
+import {
+ execute,
+ graphql,
+ GraphQLInputObjectType,
+ GraphQLObjectType,
+ GraphQLSchema,
+ parse,
+ validate,
+} from 'graphql';
import 'json-bigint-patch';
import { loadGraphQLSchemaFromOpenAPI } from '../src/loadGraphQLSchemaFromOpenAPI.js';
@@ -42,7 +50,7 @@ describe('example_api', () => {
fetch,
source: './fixtures/example_oas.json',
cwd: __dirname,
- })
+ }),
).toMatchSnapshot();
});
@@ -909,7 +917,10 @@ describe('example_api', () => {
expect(result).toEqual({
data: {
- getProductReviews: [{ timestamp: BigInt(1502787600000000) }, { timestamp: BigInt(1502787400000000) }],
+ getProductReviews: [
+ { timestamp: BigInt(1502787600000000) },
+ { timestamp: BigInt(1502787400000000) },
+ ],
},
});
});
@@ -1120,13 +1131,15 @@ describe('example_api', () => {
},
},
});
- }
+ },
);
it('Request data is correctly de-sanitized to be sent', async () => {
const query = /* GraphQL */ `
mutation {
- post_product_with_id(input: { product_name: "Soccer ball", product_id: "ball123", product_tag: "sports" }) {
+ post_product_with_id(
+ input: { product_name: "Soccer ball", product_id: "ball123", product_tag: "sports" }
+ ) {
product_name
product_id
product_tag
@@ -1174,8 +1187,8 @@ describe('example_api', () => {
execute({
schema: createdSchema,
document: parse(query),
- })
- )
+ }),
+ ),
);
expect(result1).toEqual({
@@ -1406,7 +1419,7 @@ describe('example_api', () => {
expect(
(result.data.__type as any).fields.find((field: { name: string }) => {
return field.name === 'familyCircular';
- })
+ }),
).toEqual({
name: 'familyCircular',
type: {
@@ -1670,7 +1683,10 @@ describe('example_api', () => {
it('Handle input objects without defined properties with arbitrary GraphQL JSON type', async () => {
const query = /* GraphQL */ `
mutation {
- postOfficeTrashCan(input: { type: "sandwich", message: "moldy", tasteRating: 0 }, username: "arlene") {
+ postOfficeTrashCan(
+ input: { type: "sandwich", message: "moldy", tasteRating: 0 }
+ username: "arlene"
+ ) {
contents
}
}
@@ -1752,7 +1768,7 @@ describe('example_api', () => {
expect(
(result.data.__type as any).fields.find((field: { name: string }) => {
return field.name === 'id';
- })
+ }),
).toEqual({
name: 'id',
type: {
@@ -1867,7 +1883,7 @@ describe('example_api', () => {
expect(
(result1.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'getUserByUsername';
- })
+ }),
).toEqual({
name: 'getUserByUsername',
description: 'Returns a user from the system.',
@@ -1876,19 +1892,19 @@ describe('example_api', () => {
expect(
(result1.data.__schema as any).mutationType.fields.find((field: { name: string }) => {
return field.name === 'getUserByUsername';
- })
+ }),
).toEqual(undefined);
expect(
(result2.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'getUserByUsername';
- })
+ }),
).toEqual(undefined);
expect(
(result2.data.__schema as any).mutationType.fields.find((field: { name: string }) => {
return field.name === 'getUserByUsername';
- })
+ }),
).toEqual({
name: 'getUserByUsername',
description: 'Returns a user from the system.',
@@ -1987,7 +2003,10 @@ describe('example_api', () => {
fetch,
operationHeaders: (_, operationConfig) => {
if ('method' in operationConfig) {
- if (operationConfig.method.toLowerCase() === 'get' && operationConfig.path === '/status') {
+ if (
+ operationConfig.method.toLowerCase() === 'get' &&
+ operationConfig.path === '/status'
+ ) {
return {
exampleHeader: 'some-value',
};
@@ -2056,7 +2075,7 @@ describe('example_api', () => {
expect(
(result.data.__type as any).fields.find((field: { name: string }) => {
return field.name === 'family';
- })
+ }),
).toEqual({
name: 'family',
type: {
@@ -2228,7 +2247,9 @@ describe('example_api', () => {
const ast = parse(query);
const errors = validate(schema, ast);
expect(errors.length).toBe(1);
- expect(errors[0].message).toEqual('Value "medium" does not exist in "queryInput_getSnack_snack_size" enum.');
+ expect(errors[0].message).toEqual(
+ 'Value "medium" does not exist in "queryInput_getSnack_snack_size" enum.',
+ );
});
it('Format the query params appropriately when style and explode are set to true', async () => {
diff --git a/packages/loaders/openapi/tests/example_api4.test.ts b/packages/loaders/openapi/tests/example_api4.test.ts
index b3f8fe2474bdf..48c9088b65ad6 100644
--- a/packages/loaders/openapi/tests/example_api4.test.ts
+++ b/packages/loaders/openapi/tests/example_api4.test.ts
@@ -91,7 +91,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf';
- })
+ }),
).toEqual({
name: 'anyOf',
description: 'Basic anyOf test using the same member schemas',
@@ -128,7 +128,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf2';
- })
+ }),
).toEqual({
name: 'anyOf2',
description: 'Basic anyOf test with different member schemas',
@@ -170,7 +170,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf3';
- })
+ }),
).toEqual({
name: 'anyOf3',
description: 'anyOf test with the same nested member schemas',
@@ -207,7 +207,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf4';
- })
+ }),
).toEqual({
name: 'anyOf4',
description: 'anyOf test with different nested member schemas',
@@ -250,7 +250,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf5';
- })
+ }),
).toEqual({
name: 'anyOf5',
description: 'anyOf test with different nested member schemas, leading to conflict',
@@ -286,7 +286,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf6';
- })
+ }),
).toEqual({
name: 'anyOf6',
description: 'anyOf test with incompatible member schema types',
@@ -327,7 +327,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf7';
- })
+ }),
).toEqual({
name: 'anyOf7',
description: 'anyOf test with some extraneous member schemas',
@@ -366,7 +366,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf8';
- })
+ }),
).toEqual({
name: 'anyOf8',
description: 'anyOf test with no object type member schemas',
@@ -406,7 +406,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf9';
- })
+ }),
).toEqual({
name: 'anyOf9',
description: 'anyOf test with extraneous member schemas with external type',
@@ -432,7 +432,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf10';
- })
+ }),
).toEqual({
name: 'anyOf10',
description: 'Basic anyOf test with allOf',
@@ -479,7 +479,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'anyOf11';
- })
+ }),
).toEqual({
name: 'anyOf11',
description: 'anyOf test with allOf, requiring anyOf collapse',
@@ -529,7 +529,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf';
- })
+ }),
).toEqual({
name: 'oneOf',
description: 'Basic oneOf test',
@@ -576,7 +576,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf2';
- })
+ }),
).toEqual({
name: 'oneOf2',
description: 'oneOf test with non-object type member schema',
@@ -623,7 +623,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf3';
- })
+ }),
).toEqual({
name: 'oneOf3',
description: 'oneOf test with no object type member schemas',
@@ -671,7 +671,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf4';
- })
+ }),
).toEqual({
name: 'oneOf4',
description: 'oneOf test with extraneous member schemas',
@@ -699,7 +699,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf5';
- })
+ }),
).toEqual({
name: 'oneOf5',
description: 'Basic oneOf test with allOf',
@@ -748,7 +748,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOf6';
- })
+ }),
).toEqual({
name: 'oneOf6',
description: 'oneOf test with allOf, requiring oneOf collapse',
@@ -808,7 +808,7 @@ describe('OpenAPI loader: Handle anyOf and oneOf', () => {
expect(
(result.data.__schema as any).queryType.fields.find((field: { name: string }) => {
return field.name === 'oneOfWithAllOfsAndLink';
- })
+ }),
).toEqual({
name: 'oneOfWithAllOfsAndLink',
description: null, // originaly returned "Equivalent to GET /oneOfWithAllOfsAndLink"
diff --git a/packages/loaders/openapi/tests/example_api5.test.ts b/packages/loaders/openapi/tests/example_api5.test.ts
index 76296f2278b5c..60cbb635acccd 100644
--- a/packages/loaders/openapi/tests/example_api5.test.ts
+++ b/packages/loaders/openapi/tests/example_api5.test.ts
@@ -104,7 +104,9 @@ describe('OpenAPI Loader: Testing the naming convention', () => {
it('Naming convention test with GraphQL unsafe values and a parameter', async () => {
const query = /* GraphQL */ `
{
- w_e_i_r_d___n_a_m_e2_by_f_u_n_k_y___p_a_r_a_m_e_t_e_r(f_u_n_k_y___p_a_r_a_m_e_t_e_r: "Arnold") {
+ w_e_i_r_d___n_a_m_e2_by_f_u_n_k_y___p_a_r_a_m_e_t_e_r(
+ f_u_n_k_y___p_a_r_a_m_e_t_e_r: "Arnold"
+ ) {
data
}
}
diff --git a/packages/loaders/openapi/tests/example_api6.test.ts b/packages/loaders/openapi/tests/example_api6.test.ts
index 8710f8bec6a0a..56a9f5f9fab22 100644
--- a/packages/loaders/openapi/tests/example_api6.test.ts
+++ b/packages/loaders/openapi/tests/example_api6.test.ts
@@ -303,7 +303,8 @@ describe('example_api6', () => {
expect(result.errors).toBeFalsy();
expect(result.data).toEqual({
- eateries_by_eatery_breads_by_breadName_dishes_by_dishKey: "Parameters combined: Mike's challah bread pudding",
+ eateries_by_eatery_breads_by_breadName_dishes_by_dishKey:
+ "Parameters combined: Mike's challah bread pudding",
});
});
@@ -315,7 +316,10 @@ describe('example_api6', () => {
const query = /* GraphQL */ `
{
nestedReferenceInParameter(
- russianDoll: { name: "Gertrude", nestedDoll: { name: "Tatiana", nestedDoll: { name: "Lidia" } } }
+ russianDoll: {
+ name: "Gertrude"
+ nestedDoll: { name: "Tatiana", nestedDoll: { name: "Lidia" } }
+ }
)
}
`;
@@ -364,7 +368,9 @@ describe('example_api6', () => {
expect(result.errors).toBeFalsy();
expect(
- (result.data.__type as any).fields.find((field: { name: string }) => field.name === 'post_inputUnion')
+ (result.data.__type as any).fields.find(
+ (field: { name: string }) => field.name === 'post_inputUnion',
+ ),
).toEqual({
name: 'post_inputUnion',
args: [
diff --git a/packages/loaders/openapi/tests/example_api6_server.ts b/packages/loaders/openapi/tests/example_api6_server.ts
index 5a063febfa522..5c2eba365b72c 100644
--- a/packages/loaders/openapi/tests/example_api6_server.ts
+++ b/packages/loaders/openapi/tests/example_api6_server.ts
@@ -49,7 +49,9 @@ export function startServer(PORT: number | string) {
});
app.get('/api/eateries/:eatery/breads/:breadName/dishes/:dishKey', (req, res) => {
- res.send(`Parameters combined: ${req.params.eatery} ${req.params.breadName} ${req.params.dishKey}`);
+ res.send(
+ `Parameters combined: ${req.params.eatery} ${req.params.breadName} ${req.params.dishKey}`,
+ );
});
// TODO: better types for this
@@ -71,7 +73,10 @@ export function startServer(PORT: number | string) {
app.get('/api/strictGetOperation', (req, res) => {
if (req.headers['content-type']) {
- res.status(400).set('Content-Type', 'text/plain').send('Get request should not have Content-Type');
+ res
+ .status(400)
+ .set('Content-Type', 'text/plain')
+ .send('Get request should not have Content-Type');
} else {
res.set('Content-Type', 'text/plain').send('Perfect!');
}
diff --git a/packages/loaders/openapi/tests/example_api7.test.ts b/packages/loaders/openapi/tests/example_api7.test.ts
index 5f0ed39ea9e8d..70e2dde8eed3a 100644
--- a/packages/loaders/openapi/tests/example_api7.test.ts
+++ b/packages/loaders/openapi/tests/example_api7.test.ts
@@ -79,7 +79,7 @@ describe('OpenAPI Loader: example_api7', () => {
JSON.stringify({
method: 'POST',
userName,
- })
+ }),
);
setTimeout(async () => {
@@ -123,7 +123,7 @@ describe('OpenAPI Loader: example_api7', () => {
status: false,
},
},
- })}`
+ })}`,
);
break;
}
diff --git a/packages/loaders/openapi/tests/example_api7_server.ts b/packages/loaders/openapi/tests/example_api7_server.ts
index 79679b45d895a..81b6354b9014a 100644
--- a/packages/loaders/openapi/tests/example_api7_server.ts
+++ b/packages/loaders/openapi/tests/example_api7_server.ts
@@ -46,7 +46,10 @@ export function startServer() {
if (req.body.userName && req.body.name) {
const device = req.body;
Devices[device.name] = device;
- pubsub.publish(`webhook:post:/api/${device.userName}/devices/${req.method.toUpperCase()}`, device);
+ pubsub.publish(
+ `webhook:post:/api/${device.userName}/devices/${req.method.toUpperCase()}`,
+ device,
+ );
res.status(200).send(device);
} else {
res.status(404).send({
@@ -71,7 +74,10 @@ export function startServer() {
const device = req.body;
delete Devices[req.params.deviceName];
Devices[device.deviceName] = device;
- pubsub.publish(`webhook:post:/api/${device.userName}/devices/${req.method.toUpperCase()}`, device);
+ pubsub.publish(
+ `webhook:post:/api/${device.userName}/devices/${req.method.toUpperCase()}`,
+ device,
+ );
res.status(200).send(device);
} else {
res.status(404).send({
diff --git a/packages/loaders/openapi/tests/example_api8_server.ts b/packages/loaders/openapi/tests/example_api8_server.ts
index 3a3aa2dc5ef01..1bdbd3def9e24 100644
--- a/packages/loaders/openapi/tests/example_api8_server.ts
+++ b/packages/loaders/openapi/tests/example_api8_server.ts
@@ -10,14 +10,14 @@ export function startServer(): Promise {
const app = createServerAdapter(
Router({
base: '/api',
- })
+ }),
);
app.get(
'/user',
() =>
new Response(null, {
status: 404,
- })
+ }),
);
const server = createServer(app);
diff --git a/packages/loaders/openapi/tests/example_api_server.ts b/packages/loaders/openapi/tests/example_api_server.ts
index 5c7d7c5eb149f..27ec1cbbf6675 100644
--- a/packages/loaders/openapi/tests/example_api_server.ts
+++ b/packages/loaders/openapi/tests/example_api_server.ts
@@ -322,7 +322,10 @@ export function startServer() {
};
for (const user in Auth) {
- if (Auth[user].username === credentials.username && Auth[user].password === credentials.password) {
+ if (
+ Auth[user].username === credentials.username &&
+ Auth[user].password === credentials.password
+ ) {
return undefined;
}
}
@@ -336,7 +339,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
} else if (authType === 'Bearer') {
@@ -360,7 +363,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
} else if (cookieHeader) {
for (const user in Auth) {
@@ -377,7 +380,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
} else if ('access_token' in req.query) {
for (const user in Auth) {
@@ -394,7 +397,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
} else {
return new Response(
@@ -406,7 +409,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
};
@@ -445,7 +448,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -468,7 +471,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -494,7 +497,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -518,7 +521,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -579,7 +582,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -594,17 +597,20 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
});
app.get('/api/cookie', (req: IttyRequest & { cookies: Record }) => {
if (req.cookies && req.cookies.cookie_type && req.cookies.cookie_size) {
- return new Response(`You ordered a ${req.cookies.cookie_size} ${req.cookies.cookie_type} cookie!`, {
- headers: {
- 'Content-Type': 'text/plain',
+ return new Response(
+ `You ordered a ${req.cookies.cookie_size} ${req.cookies.cookie_type} cookie!`,
+ {
+ headers: {
+ 'Content-Type': 'text/plain',
+ },
},
- });
+ );
} else {
return new Response('Need cookie header parameter', {
status: 400,
@@ -624,7 +630,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
});
@@ -676,7 +682,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
} else {
@@ -706,7 +712,7 @@ export function startServer() {
}),
{
status: 400,
- }
+ },
);
}
});
@@ -731,7 +737,7 @@ export function startServer() {
}),
{
status: 400,
- }
+ },
);
}
});
@@ -754,7 +760,7 @@ export function startServer() {
}),
{
status: 400,
- }
+ },
);
}
});
@@ -784,7 +790,7 @@ export function startServer() {
}),
{
status: 400,
- }
+ },
);
}
});
@@ -811,7 +817,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -833,7 +839,7 @@ export function startServer() {
}),
{
status: 400,
- }
+ },
);
}
});
@@ -860,7 +866,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -884,7 +890,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
});
@@ -909,7 +915,10 @@ export function startServer() {
});
app.get('/api/status', (req: Request & IttyRequest) => {
- if (typeof req.query.limit !== 'undefined' && typeof req.headers.get('exampleHeader') !== 'undefined') {
+ if (
+ typeof req.query.limit !== 'undefined' &&
+ typeof req.headers.get('exampleHeader') !== 'undefined'
+ ) {
return new Response('Ok', {
status: 200,
headers: {
@@ -926,7 +935,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -950,7 +959,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -973,7 +982,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -1004,7 +1013,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -1031,7 +1040,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
}
});
@@ -1046,7 +1055,7 @@ export function startServer() {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
});
diff --git a/packages/loaders/openapi/tests/explode.test.ts b/packages/loaders/openapi/tests/explode.test.ts
index 411dda8e50620..0b77283b6bb63 100644
--- a/packages/loaders/openapi/tests/explode.test.ts
+++ b/packages/loaders/openapi/tests/explode.test.ts
@@ -17,7 +17,7 @@ describe('Explode parameter', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
});
diff --git a/packages/loaders/openapi/tests/file-upload.test.ts b/packages/loaders/openapi/tests/file-upload.test.ts
index 0ae854a953c71..ec1fade1dcd08 100644
--- a/packages/loaders/openapi/tests/file-upload.test.ts
+++ b/packages/loaders/openapi/tests/file-upload.test.ts
@@ -2,7 +2,10 @@
import { createYoga } from 'graphql-yoga';
import { fetch, File, FormData } from '@whatwg-node/fetch';
import { graphql, GraphQLSchema } from 'graphql';
-import { startServer as startAPIServer, stopServer as stopAPIServer } from './file_upload_api_server.js';
+import {
+ startServer as startAPIServer,
+ stopServer as stopAPIServer,
+} from './file_upload_api_server.js';
import loadGraphQLSchemaFromOpenAPI from '../src/index.js';
import { createServer, Server } from 'http';
import { AddressInfo } from 'net';
diff --git a/packages/loaders/openapi/tests/fixtures/calendly.yml b/packages/loaders/openapi/tests/fixtures/calendly.yml
index 3ed0b32d81fd1..b6f1fc65e2365 100644
--- a/packages/loaders/openapi/tests/fixtures/calendly.yml
+++ b/packages/loaders/openapi/tests/fixtures/calendly.yml
@@ -56,7 +56,9 @@ paths:
schema:
type: string
default: 'created_at:asc'
- description: 'Order results by the **created_at** field and direction specified: ascending ("asc") or descending ("desc")'
+ description:
+ 'Order results by the **created_at** field and direction specified: ascending ("asc") or
+ descending ("desc")'
- name: email
in: query
schema:
@@ -190,14 +192,16 @@ paths:
example: 'https://api.calendly.com/organizations/EBHAAFHDCAEQTSEZ'
in: query
name: organization
- description: Return events that are scheduled with the organization associated with this URI
+ description:
+ Return events that are scheduled with the organization associated with this URI
- name: invitee_email
in: query
schema:
type: string
format: email
example: alice@example.com
- description: Return events that are scheduled with the invitee associated with this email address
+ description:
+ Return events that are scheduled with the invitee associated with this email address
- name: status
in: query
schema:
@@ -219,13 +223,17 @@ paths:
in: query
schema:
type: string
- description: 'Include events with start times after this time (sample time format: "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.'
+ description:
+ 'Include events with start times after this time (sample time format:
+ "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.'
example: '2020-01-02T12:30:00.000000Z'
- name: max_start_time
in: query
schema:
type: string
- description: 'Include events with start times prior to this time (sample time format: "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.'
+ description:
+ 'Include events with start times prior to this time (sample time format:
+ "2020-01-02T03:04:05.678123Z"). This time should use the UTC timezone.'
example: '2020-01-02T12:30:00.000000Z'
- $ref: '#/components/parameters/PageToken'
- $ref: '#/components/parameters/Count'
@@ -309,19 +317,25 @@ paths:
- personal_access_token: []
parameters:
- name: active
- description: 'Return only active event types if true, only inactive if false, or all event types if this parameter is omitted.'
+ description:
+ 'Return only active event types if true, only inactive if false, or all event types if
+ this parameter is omitted.'
in: query
schema:
type: boolean
- name: organization
- description: "View available personal, team, and organization event types associated with the organization's URI."
+ description:
+ "View available personal, team, and organization event types associated with the
+ organization's URI."
in: query
schema:
type: string
format: uri
required: false
- name: user
- description: "View available personal, team, and organization event types associated with the user's URI."
+ description:
+ "View available personal, team, and organization event types associated with the user's
+ URI."
in: query
schema:
type: string
@@ -923,7 +937,8 @@ paths:
'500':
$ref: '#/components/responses/UNKNOWN'
operationId: get-organizations-uuid-invitations
- description: Returns a list of Organization Invitations that were sent to the organization's members.
+ description:
+ Returns a list of Organization Invitations that were sent to the organization's members.
security:
- oauth2: []
- personal_access_token: []
@@ -935,7 +950,9 @@ paths:
default: 'created_at:asc'
in: query
name: sort
- description: Order results by the field name and direction specified (ascending or descending). Returns multiple sets of results in a comma-separated list.
+ description:
+ Order results by the field name and direction specified (ascending or descending).
+ Returns multiple sets of results in a comma-separated list.
- schema:
type: string
format: email
@@ -951,7 +968,9 @@ paths:
- declined
in: query
name: status
- description: 'Indicates if the results should be filtered by status ("pending", "accepted", or "declined")'
+ description:
+ 'Indicates if the results should be filtered by status ("pending", "accepted", or
+ "declined")'
tags:
- Organizations
post:
@@ -1008,7 +1027,9 @@ paths:
Race Condition:
value:
title: Race Condition
- message: A race condition occurred when processing the request. Please try the request again.
+ message:
+ A race condition occurred when processing the request. Please try the request
+ again.
'401':
$ref: '#/components/responses/UNAUTHENTICATED'
'403':
@@ -1025,7 +1046,9 @@ paths:
message:
type: string
enum:
- - You already sent all the invitations you're allotted based upon the number of seats purchased with your account. Please purchase more seats to send more invitations.
+ - You already sent all the invitations you're allotted based upon the number
+ of seats purchased with your account. Please purchase more seats to send
+ more invitations.
- You already sent all the invitations allotted to you with a trial account.
- You do not have permission
- You cannot perform this action for an organization with SCIM enabled.
@@ -1033,11 +1056,15 @@ paths:
Quantity Overflow:
value:
title: Permission Denied
- message: You already sent all the invitations you're allotted based upon the number of seats purchased with your account. Please purchase more seats to send more invitations.
+ message:
+ You already sent all the invitations you're allotted based upon the number of
+ seats purchased with your account. Please purchase more seats to send more
+ invitations.
Trial Quantity Overflow:
value:
title: Permission Denied
- message: You already sent all the invitations allotted to you with a trial account.
+ message:
+ You already sent all the invitations allotted to you with a trial account.
'404':
$ref: '#/components/responses/NOT_FOUND'
'500':
@@ -1108,7 +1135,9 @@ paths:
'500':
$ref: '#/components/responses/UNKNOWN'
operationId: revoke-users-organization-invitation
- description: 'Use this to revoke an Organization Invitation to an organization. Once revoked, the invitation link that was sent to the invitee is no longer valid.'
+ description:
+ 'Use this to revoke an Organization Invitation to an organization. Once revoked, the
+ invitation link that was sent to the invitee is no longer valid.'
security:
- oauth2: []
- personal_access_token: []
@@ -1463,7 +1492,9 @@ paths:
properties:
url:
type: string
- description: The URL where you want to receive POST requests for events you are subscribed to.
+ description:
+ The URL where you want to receive POST requests for events you are subscribed
+ to.
format: uri
events:
type: array
@@ -1477,7 +1508,8 @@ paths:
- routing_form_submission.created
organization:
type: string
- description: The unique reference to the organization that the webhook will be tied to.
+ description:
+ The unique reference to the organization that the webhook will be tied to.
format: uri
user:
type: string
@@ -1488,10 +1520,14 @@ paths:
enum:
- organization
- user
- description: Indicates if the webhook subscription scope will be "organization" or "user"
+ description:
+ Indicates if the webhook subscription scope will be "organization" or "user"
signing_key:
type: string
- description: 'Optional secret key shared between your application and Calendly. See https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for additional information.'
+ description:
+ 'Optional secret key shared between your application and Calendly. See
+ https://developer.calendly.com/api-docs/ZG9jOjM2MzE2MDM4-webhook-signatures for
+ additional information.'
required:
- url
- events
@@ -1588,7 +1624,9 @@ paths:
format: uri
in: query
name: user
- description: Indicates if the results should be filtered by user. This parameter is only required if the `scope` parameter is set to `user`.
+ description:
+ Indicates if the results should be filtered by user. This parameter is only required if
+ the `scope` parameter is set to `user`.
- $ref: '#/components/parameters/PageToken'
- $ref: '#/components/parameters/Count'
- schema:
@@ -1704,7 +1742,9 @@ paths:
example: 'https://calendly.com/d/abcd-brv8/15-minute-meeting'
owner:
type: string
- description: 'A link to the resource that owns this Scheduling Link (currently, this is always an Event Type)'
+ description:
+ 'A link to the resource that owns this Scheduling Link (currently, this is
+ always an Event Type)'
format: uri
example: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2'
owner_type:
@@ -1745,13 +1785,16 @@ paths:
properties:
max_event_count:
type: number
- description: The max number of events that can be scheduled using this scheduling link.
+ description:
+ The max number of events that can be scheduled using this scheduling link.
enum:
- 1
example: 1
owner:
type: string
- description: 'A link to the resource that owns this Scheduling Link (currently, this is always an Event Type)'
+ description:
+ 'A link to the resource that owns this Scheduling Link (currently, this is
+ always an Event Type)'
format: uri
example: 'https://api.calendly.com/event_types/012345678901234567890'
owner_type:
@@ -1830,7 +1873,10 @@ paths:
Invalid Data Request Permission:
value:
title: Permission Denied
- message: You must be an admin/owner with the data requests permission enabled to use this resource. Contact Calendly support and ask them to grant you data requests permission.
+ message:
+ You must be an admin/owner with the data requests permission enabled to use
+ this resource. Contact Calendly support and ask them to grant you data
+ requests permission.
'404':
$ref: '#/components/responses/NOT_FOUND'
'500':
@@ -2117,7 +2163,10 @@ paths:
example: 'created_at:asc'
in: query
name: sort
- description: 'Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.'
+ description:
+ 'Order results by the specified field and direction. Accepts comma-separated list of
+ {field}:{direction} values. Supported fields are: created_at. Sort direction is
+ specified as: asc, desc.'
'/routing_forms/{uuid}':
parameters:
- schema:
@@ -2263,7 +2312,10 @@ paths:
example: 'created_at:asc'
in: query
name: sort
- description: 'Order results by the specified field and direction. Accepts comma-separated list of {field}:{direction} values. Supported fields are: created_at. Sort direction is specified as: asc, desc.'
+ description:
+ 'Order results by the specified field and direction. Accepts comma-separated list of
+ {field}:{direction} values. Supported fields are: created_at. Sort direction is
+ specified as: asc, desc.'
x-internal: false
'/routing_form_submissions/{uuid}':
parameters:
@@ -2478,7 +2530,8 @@ paths:
- 'occurred_at:desc'
default:
- 'occurred_at:desc'
- description: 'Order results by the specified field and direction. List of {field}:{direction} values.'
+ description:
+ 'Order results by the specified field and direction. List of {field}:{direction} values.'
example:
- 'occurred_at:asc'
- name: min_occurred_at
@@ -2486,14 +2539,18 @@ paths:
schema:
type: string
format: date-time
- description: 'Include entries that occurred after this time (sample time format: "2020-01-02T03:04:05.678Z"). This time should use the UTC timezone.'
+ description:
+ 'Include entries that occurred after this time (sample time format:
+ "2020-01-02T03:04:05.678Z"). This time should use the UTC timezone.'
example: '2020-01-02T12:30:00Z'
- name: max_occurred_at
in: query
schema:
type: string
format: date-time
- description: 'Include entries that occurred prior to this time (sample time format: "2020-01-02T03:04:05.678Z"). This time should use the UTC timezone.'
+ description:
+ 'Include entries that occurred prior to this time (sample time format:
+ "2020-01-02T03:04:05.678Z"). This time should use the UTC timezone.'
example: '2020-01-02T12:30:00Z'
- name: page_token
description: The token to pass to get the next portion of the collection
@@ -2547,14 +2604,18 @@ paths:
type: string
format: date-time
nullable: true
- description: 'The date and time of the newest entry (format: "2020-01-02T03:04:05.678Z") in the collection array.'
+ description:
+ 'The date and time of the newest entry (format: "2020-01-02T03:04:05.678Z") in
+ the collection array.'
total_count:
type: integer
description: Total number of records based on search criteria
minimum: 0
exceeds_max_total_count:
type: boolean
- description: 'If there are more search results than the total_count field indicates, pagination will continue to return results past the total_count field value.'
+ description:
+ 'If there are more search results than the total_count field indicates,
+ pagination will continue to return results past the total_count field value.'
required:
- collection
- pagination
@@ -2647,7 +2708,9 @@ components:
example: John Doe
slug:
type: string
- description: "The portion of URL for the user's scheduling page (where invitees book sessions), rendered in a human-readable format"
+ description:
+ "The portion of URL for the user's scheduling page (where invitees book sessions),
+ rendered in a human-readable format"
example: acmesales
email:
type: string
@@ -2657,7 +2720,8 @@ components:
scheduling_url:
type: string
format: uri
- description: The URL of the user's Calendly landing page (that lists all the user's event types)
+ description:
+ The URL of the user's Calendly landing page (that lists all the user's event types)
example: 'https://calendly.com/acmesales'
timezone:
type: string
@@ -2673,12 +2737,15 @@ components:
type: string
format: date-time
example: '2019-01-02T03:04:05.678123Z'
- description: 'The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")'
updated_at:
type: string
format: date-time
example: '2019-08-07T06:05:04.321123Z'
- description: 'The moment when the user''s record was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the user''s record was last updated (e.g.
+ "2020-01-02T03:04:05.678123Z")'
current_organization:
type: string
description: A unique reference to the user's current organization
@@ -2785,7 +2852,9 @@ components:
type: boolean
slug:
type: string
- description: The portion of the event type's URL that identifies a specific web page (in a human-readable format)
+ description:
+ The portion of the event type's URL that identifies a specific web page (in a
+ human-readable format)
example: acmesales
nullable: true
scheduling_url:
@@ -2798,20 +2867,26 @@ components:
type: number
example: 30
kind:
- description: Indicates if the event type is "solo" (belongs to an individual user) or "group"
+ description:
+ Indicates if the event type is "solo" (belongs to an individual user) or "group"
type: string
enum:
- solo
- group
pooling_type:
- description: Indicates if the event type is "round robin" (alternates between hosts) or "collective" (invitees pick a time when all participants are available) or "null" (the event type doesn’t consider the availability of a group participants)
+ description:
+ Indicates if the event type is "round robin" (alternates between hosts) or "collective"
+ (invitees pick a time when all participants are available) or "null" (the event type
+ doesn’t consider the availability of a group participants)
type: string
enum:
- round_robin
- collective
nullable: true
type:
- description: Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType" (standard event type)
+ description:
+ Indicates if the event type is "AdhocEventType" (ad hoc event) or "StandardEventType"
+ (standard event type)
type: string
enum:
- StandardEventType
@@ -2827,7 +2902,8 @@ components:
format: date-time
example: '2019-01-02T03:04:05.678123Z'
updated_at:
- description: 'The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment the event type was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
type: string
format: date-time
example: '2019-08-07T06:05:04.321123Z'
@@ -2864,7 +2940,10 @@ components:
$ref: '#/components/schemas/EventTypeCustomQuestion'
deleted_at:
type: string
- description: 'The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z"). Since event types can be deleted but their scheduled events remain it''s useful to fetch a deleted event type when you still require event type data for a scheduled event.'
+ description:
+ 'The moment the event type was deleted (e.g. "2020-01-02T03:04:05.678123Z"). Since event
+ types can be deleted but their scheduled events remain it''s useful to fetch a deleted
+ event type when you still require event type data for a scheduled event.'
format: date-time
example: '2019-01-02T03:04:05.678123Z'
nullable: true
@@ -2894,7 +2973,9 @@ components:
- Event Types
type: object
nullable: true
- description: "The publicly visible profile of a User or a Team that's associated with the Event Type (note: some Event Types don't have profiles)"
+ description:
+ "The publicly visible profile of a User or a Team that's associated with the Event Type
+ (note: some Event Types don't have profiles)"
title: Profile
properties:
type:
@@ -2906,7 +2987,8 @@ components:
example: User
name:
type: string
- description: Human-readable name for the profile of the user that's associated with the event type
+ description:
+ Human-readable name for the profile of the user that's associated with the event type
example: Tamara Jones
owner:
type: string
@@ -2971,11 +3053,15 @@ components:
start_time:
type: string
format: date-time
- description: 'The moment the event was scheduled to start in UTC time (e.g. "2020-01-02T03:04:05.678123Z").'
+ description:
+ 'The moment the event was scheduled to start in UTC time (e.g.
+ "2020-01-02T03:04:05.678123Z").'
end_time:
type: string
format: date-time
- description: 'The moment the event was scheduled to end in UTC time (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment the event was scheduled to end in UTC time (e.g.
+ "2020-01-02T03:04:05.678123Z")'
event_type:
type: string
description: The event type associated with this event
@@ -3007,7 +3093,8 @@ components:
updated_at:
type: string
format: date-time
- description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
example: '2019-01-02T03:04:05.678123Z'
event_memberships:
type: array
@@ -3160,12 +3247,18 @@ components:
example: test@example.com
first_name:
type: string
- description: The first name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name.
+ description:
+ The first name of the invitee who booked the event when the event type is configured to
+ use separate fields for first name and last name. Null when event type is configured to
+ use a single field for name.
example: John
nullable: true
last_name:
type: string
- description: The last name of the invitee who booked the event when the event type is configured to use separate fields for first name and last name. Null when event type is configured to use a single field for name.
+ description:
+ The last name of the invitee who booked the event when the event type is configured to
+ use separate fields for first name and last name. Null when event type is configured to
+ use a single field for name.
example: Doe
nullable: true
name:
@@ -3180,7 +3273,9 @@ components:
description: Indicates if the invitee is "active" or "canceled"
questions_and_answers:
type: array
- description: A collection of the invitee's responses to questions on the event booking confirmation form
+ description:
+ A collection of the invitee's responses to questions on the event booking confirmation
+ form
minItems: 0
uniqueItems: true
items:
@@ -3203,7 +3298,8 @@ components:
type: string
format: date-time
example: '2019-08-07T06:05:04.321123Z'
- description: 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the event was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
tracking:
$ref: '#/components/schemas/InviteeTracking'
text_reminder_number:
@@ -3213,7 +3309,9 @@ components:
nullable: true
rescheduled:
type: boolean
- description: 'Indicates if this invitee has rescheduled. If `true`, a reference to the new Invitee instance is provided in the `new_invitee` field.'
+ description:
+ 'Indicates if this invitee has rescheduled. If `true`, a reference to the new Invitee
+ instance is provided in the `new_invitee` field.'
old_invitee:
type: string
format: uri
@@ -3236,7 +3334,8 @@ components:
type: string
format: uri
example: 'https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA'
- description: Reference to a routing form submission that redirected the invitee to a booking page.
+ description:
+ Reference to a routing form submission that redirected the invitee to a booking page.
nullable: true
cancellation:
$ref: '#/components/schemas/Cancellation'
@@ -3301,7 +3400,11 @@ components:
description: The moment when the no show was created
reconfirmation:
type: object
- description: 'Assuming reconfirmation is enabled for the event type, when reconfirmation is requested this object is present with a `created_at` that reflects when the reconfirmation notification was sent. Once the invitee has reconfirmed the `confirmed_at` attribute will change from `null` to a timestamp that reflects when they took action.'
+ description:
+ 'Assuming reconfirmation is enabled for the event type, when reconfirmation is requested
+ this object is present with a `created_at` that reflects when the reconfirmation
+ notification was sent. Once the invitee has reconfirmed the `confirmed_at` attribute
+ will change from `null` to a timestamp that reflects when they took action.'
required:
- created_at
- confirmed_at
@@ -3456,7 +3559,9 @@ components:
example: John Doe
slug:
type: string
- description: "The portion of URL for the user's scheduling page (where invitees book sessions), rendered in a human-readable format"
+ description:
+ "The portion of URL for the user's scheduling page (where invitees book sessions),
+ rendered in a human-readable format"
example: acmesales
email:
type: string
@@ -3466,7 +3571,8 @@ components:
scheduling_url:
type: string
format: uri
- description: The URL of the user's Calendly landing page (that lists all the user's event types)
+ description:
+ The URL of the user's Calendly landing page (that lists all the user's event types)
example: 'https://calendly.com/acmesales'
timezone:
type: string
@@ -3482,12 +3588,15 @@ components:
type: string
format: date-time
example: '2019-01-02T03:04:05.678123Z'
- description: 'The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the user''s record was created (e.g. "2020-01-02T03:04:05.678123Z")'
updated_at:
type: string
format: date-time
example: '2019-08-07T06:05:04.321123Z'
- description: 'The moment when the user''s record was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the user''s record was last updated (e.g.
+ "2020-01-02T03:04:05.678123Z")'
organization:
type: string
format: uri
@@ -3497,12 +3606,15 @@ components:
type: string
format: date-time
example: '2019-08-07T06:05:04.321123Z'
- description: 'The moment when the membership record was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the membership record was last updated (e.g.
+ "2020-01-02T03:04:05.678123Z")'
created_at:
type: string
format: date-time
example: '2019-01-02T03:04:05.678123Z'
- description: 'The moment when the membership record was created (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the membership record was created (e.g. "2020-01-02T03:04:05.678123Z")'
required:
- uri
- role
@@ -3565,17 +3677,20 @@ components:
type: string
format: date-time
example: '2019-01-02T03:04:05.678123Z'
- description: 'The moment the invitation was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment the invitation was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
last_sent_at:
type: string
nullable: true
- description: 'The moment the invitation was last sent (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment the invitation was last sent (e.g. "2020-01-02T03:04:05.678123Z")'
format: date-time
example: '2019-01-02T03:04:05.678123Z'
user:
type: string
format: uri
- description: 'When the invitation is accepted, a reference to the user who accepted the invitation'
+ description:
+ 'When the invitation is accepted, a reference to the user who accepted the invitation'
example: 'https://api.calendly.com/users/AAAAAAAAAAAAAAAA'
required:
- uri
@@ -3749,11 +3864,15 @@ components:
example: 'https://blah.foo/bar'
created_at:
type: string
- description: 'The moment when the webhook subscription was created (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the webhook subscription was created (e.g.
+ "2020-01-02T03:04:05.678123Z")'
format: date-time
updated_at:
type: string
- description: 'The moment when the webhook subscription was last updated (e.g. "2020-01-02T03:04:05.678123Z")'
+ description:
+ 'The moment when the webhook subscription was last updated (e.g.
+ "2020-01-02T03:04:05.678123Z")'
format: date-time
retry_started_at:
type: string
@@ -3973,14 +4092,17 @@ components:
submitter:
type: string
example: 'https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA'
- description: The reference to the Invitee resource when routing form submission results in a scheduled meeting.
+ description:
+ The reference to the Invitee resource when routing form submission results in a
+ scheduled meeting.
format: uri
nullable: true
submitter_type:
type: string
enum:
- Invitee
- description: Type of the respondent resource that submitted the form and scheduled a meeting.
+ description:
+ Type of the respondent resource that submitted the form and scheduled a meeting.
nullable: true
created_at:
type: string
@@ -4020,7 +4142,10 @@ components:
example: available
invitees_remaining:
type: number
- description: 'Total remaining invitees for this available time. For Group Event Type, more than one invitee can book in this available time. For all other Event Types, only one invitee can book in this available time.'
+ description:
+ 'Total remaining invitees for this available time. For Group Event Type, more than one
+ invitee can book in this available time. For all other Event Types, only one invitee can
+ book in this available time.'
example: 2
start_time:
type: string
@@ -4125,16 +4250,24 @@ components:
- phone_number
- single_select
- multi_select
- description: 'The type of response that the invitee provides to the custom question; can be one or multiple lines of text, a phone number, or single- or multiple-select.'
+ description:
+ 'The type of response that the invitee provides to the custom question; can be one or
+ multiple lines of text, a phone number, or single- or multiple-select.'
position:
type: number
- description: The numerical position of the question on the event booking page after the name and email address fields.
+ description:
+ The numerical position of the question on the event booking page after the name and
+ email address fields.
enabled:
type: boolean
- description: true if the question created by the host is turned ON and visible on the event booking page; false if turned OFF and invisible on the event booking page.
+ description:
+ true if the question created by the host is turned ON and visible on the event booking
+ page; false if turned OFF and invisible on the event booking page.
required:
type: boolean
- description: true if a response to the question created by the host is required for invitees to book the event type; false if not required.
+ description:
+ true if a response to the question created by the host is required for invitees to book
+ the event type; false if not required.
answer_choices:
type: array
description: The invitee’s option(s) for single_select or multi_select type of responses.
@@ -4142,7 +4275,9 @@ components:
type: string
include_other:
type: boolean
- description: true if the custom question lets invitees record a written response in addition to single-select or multiple-select type of responses; false if it doesn’t.
+ description:
+ true if the custom question lets invitees record a written response in addition to
+ single-select or multiple-select type of responses; false if it doesn’t.
required:
- name
- type
@@ -4209,11 +4344,14 @@ components:
utm_source:
type: string
nullable: true
- description: The UTM parameter that identifies the source (platform where the traffic originates)
+ description:
+ The UTM parameter that identifies the source (platform where the traffic originates)
utm_medium:
type: string
nullable: true
- description: 'The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code)'
+ description:
+ 'The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social
+ media, affiliate or QR code)'
utm_content:
type: string
nullable: true
@@ -4269,23 +4407,31 @@ components:
type: string
nullable: true
format: uri
- description: URI to return the next page of an ordered list ("null" indicates no additional results are available)
+ description:
+ URI to return the next page of an ordered list ("null" indicates no additional results
+ are available)
example: 'https://api.calendly.com/event_types?count=1&page_token=sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi'
previous_page:
type: string
nullable: true
format: uri
- description: URI to return the previous page of an ordered list ("null" indicates no additional results are available)
+ description:
+ URI to return the previous page of an ordered list ("null" indicates no additional
+ results are available)
example: 'https://api.calendly.com/event_types?count=1&page_token=VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H'
next_page_token:
type: string
nullable: true
- description: Token to return the next page of an ordered list ("null" indicates no additional results are available)
+ description:
+ Token to return the next page of an ordered list ("null" indicates no additional results
+ are available)
example: sNjq4TvMDfUHEl7zHRR0k0E1PCEJWvdi
previous_page_token:
type: string
nullable: true
- description: Token to return the previous page of an ordered list ("null" indicates no additional results are available)
+ description:
+ Token to return the previous page of an ordered list ("null" indicates no additional
+ results are available)
example: VJs2rfDYeY8ahZpq0QI1O114LJkNjd7H
required:
- count
@@ -4464,7 +4610,9 @@ components:
type: string
enum:
- custom
- description: The event location doesn't fall into a standard category defined by the event host (publisher)
+ description:
+ The event location doesn't fall into a standard category defined by the event host
+ (publisher)
location:
nullable: true
description: The location description provided by the event host (publisher)
@@ -4473,7 +4621,8 @@ components:
- type
- location
GoogleConference:
- description: Details about an Event that will take place using a Google Meet / Hangout conference
+ description:
+ Details about an Event that will take place using a Google Meet / Hangout conference
type: object
title: Google Conference
x-examples:
@@ -4966,7 +5115,9 @@ components:
- textarea
- select
- radios
- description: 'Question type: name, text input, email, phone, textarea input, dropdown list or radio button list.'
+ description:
+ 'Question type: name, text input, email, phone, textarea input, dropdown list or radio
+ button list.'
required:
type: boolean
description: |
@@ -5002,7 +5153,8 @@ components:
type: string
enum:
- custom_message
- description: Indicates if the routing form submission resulted in a custom "thank you" message.
+ description:
+ Indicates if the routing form submission resulted in a custom "thank you" message.
value:
type: object
required:
@@ -5038,7 +5190,9 @@ components:
type: string
enum:
- event_type
- description: Indicates that the routing form submission resulted in a redirect to an event type booking page.
+ description:
+ Indicates that the routing form submission resulted in a redirect to an event type
+ booking page.
value:
type: string
example: 'https://api.calendly.com/event_types/GBGBDCAADAEDCRZ2'
@@ -5064,7 +5218,8 @@ components:
type: string
enum:
- external_url
- description: Indicates that the routing form submission resulted in a redirect to an external URL.
+ description:
+ Indicates that the routing form submission resulted in a redirect to an external URL.
value:
type: string
format: uri
@@ -5140,7 +5295,8 @@ components:
utm_content: UTM Content
utm_term: UTM Term
salesforce_uuid: 5003000000D8cuIQAA
- description: The UTM and Salesforce tracking parameters associated with a Routing Form Submission.
+ description:
+ The UTM and Salesforce tracking parameters associated with a Routing Form Submission.
x-tags:
- Routing Forms
properties:
@@ -5150,11 +5306,14 @@ components:
nullable: true
utm_source:
type: string
- description: The UTM parameter that identifies the source (platform where the traffic originates).
+ description:
+ The UTM parameter that identifies the source (platform where the traffic originates).
nullable: true
utm_medium:
type: string
- description: 'The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social media, affiliate or QR code).'
+ description:
+ 'The UTM parameter that identifies the type of input (e.g. Cost Per Click (CPC), social
+ media, affiliate or QR code).'
nullable: true
utm_content:
type: string
@@ -5234,7 +5393,8 @@ components:
- You are not allowed to view this event
- Please upgrade your Calendly account to Professional
- Please upgrade your Calendly account to Enterprise.
- - Please also specify organization when requesting events for a user within your organization.
+ - Please also specify organization when requesting events for a user within
+ your organization.
- Unauthorized
- You cannot perform this action for an organization with SCIM enabled.
NOT_FOUND:
@@ -5278,7 +5438,8 @@ components:
message:
type: string
enum:
- - The server encountered an unexpected condition that prevented it from fulfilling the request.
+ - The server encountered an unexpected condition that prevented it from
+ fulfilling the request.
ALREADY_EXISTS:
description: Attempt to create a resource that already exists
content:
diff --git a/packages/loaders/openapi/tests/fixtures/cloudflare.json b/packages/loaders/openapi/tests/fixtures/cloudflare.json
index bc7460780edaf..97484e7da6370 100644
--- a/packages/loaders/openapi/tests/fixtures/cloudflare.json
+++ b/packages/loaders/openapi/tests/fixtures/cloudflare.json
@@ -6,7 +6,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["0rtt"], "example": "0rtt" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["0rtt"],
+ "example": "0rtt"
+ },
"value": { "$ref": "#/components/schemas/0rtt_value" }
}
}
@@ -86,7 +90,13 @@
"minimum": 0,
"type": "number"
},
- "type": { "description": "Type.", "example": 9, "maximum": 65535, "minimum": 0, "type": "number" }
+ "type": {
+ "description": "Type.",
+ "example": 9,
+ "maximum": 65535,
+ "minimum": 0,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -125,7 +135,12 @@
"description": "A and AAAA records associated with the nameserver.",
"items": {
"properties": {
- "type": { "description": "DNS record type.", "enum": ["A", "AAAA"], "example": "A", "type": "string" },
+ "type": {
+ "description": "DNS record type.",
+ "enum": ["A", "AAAA"],
+ "example": "A",
+ "type": "string"
+ },
"value": {
"description": "DNS record contents (an IPv4 or IPv6 address).",
"example": "1.1.1.1",
@@ -172,7 +187,13 @@
"minimum": 0,
"type": "number"
},
- "flags": { "description": "Flags.", "example": 1, "maximum": 65535, "minimum": 0, "type": "number" },
+ "flags": {
+ "description": "Flags.",
+ "example": 1,
+ "maximum": 65535,
+ "minimum": 0,
+ "type": "number"
+ },
"protocol": {
"description": "Protocol.",
"example": 3,
@@ -308,7 +329,11 @@
"minimum": 0,
"type": "number"
},
- "lat_direction": { "description": "Latitude direction.", "enum": ["N", "S"], "example": "N" },
+ "lat_direction": {
+ "description": "Latitude direction.",
+ "enum": ["N", "S"],
+ "example": "N"
+ },
"lat_minutes": {
"default": 0,
"description": "Minutes of latitude.",
@@ -332,7 +357,11 @@
"minimum": 0,
"type": "number"
},
- "long_direction": { "description": "Longitude direction.", "enum": ["E", "W"], "example": "W" },
+ "long_direction": {
+ "description": "Longitude direction.",
+ "enum": ["E", "W"],
+ "example": "W"
+ },
"long_minutes": {
"default": 0,
"description": "Minutes of longitude.",
@@ -451,7 +480,10 @@
{ "$ref": "#/components/schemas/dns-record_components-schemas-base" },
{
"properties": {
- "content": { "description": "A valid name server host name.", "example": "ns1.example.com" },
+ "content": {
+ "description": "A valid name server host name.",
+ "example": "ns1.example.com"
+ },
"name": { "$ref": "#/components/schemas/dns-record_components-schemas-name" },
"type": { "description": "Record type.", "enum": ["NS"], "example": "NS" }
}
@@ -488,7 +520,13 @@
"minimum": 0,
"type": "number"
},
- "usage": { "description": "Usage.", "example": 3, "maximum": 255, "minimum": 0, "type": "number" }
+ "usage": {
+ "description": "Usage.",
+ "example": 3,
+ "maximum": 255,
+ "minimum": 0,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -528,7 +566,11 @@
"type": "number"
},
"priority": { "$ref": "#/components/schemas/priority" },
- "proto": { "description": "A valid protocol.", "example": "_tcp", "type": "string" },
+ "proto": {
+ "description": "A valid protocol.",
+ "example": "_tcp",
+ "type": "string"
+ },
"service": {
"description": "A service type, prefixed with an underscore.",
"example": "_sip",
@@ -585,7 +627,13 @@
"type": "number"
},
"fingerprint": { "description": "fingerprint.", "type": "string" },
- "type": { "description": "type.", "example": 1, "maximum": 255, "minimum": 0, "type": "number" }
+ "type": {
+ "description": "type.",
+ "example": 1,
+ "maximum": 255,
+ "minimum": 0,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -662,7 +710,13 @@
"minimum": 0,
"type": "number"
},
- "usage": { "description": "Usage.", "example": 0, "maximum": 255, "minimum": 0, "type": "number" }
+ "usage": {
+ "description": "Usage.",
+ "example": 0,
+ "maximum": 255,
+ "minimum": 0,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -752,12 +806,19 @@
"example": "login",
"type": "string"
},
- "access-requests_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "access-requests_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"access-requests_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/access-requests" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/access-requests" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -813,7 +874,11 @@
"title": "Access groups",
"type": "object"
},
- "access_seat": { "description": "True if the seat is part of Access.", "example": false, "type": "boolean" },
+ "access_seat": {
+ "description": "True if the seat is part of Access.",
+ "example": false,
+ "type": "boolean"
+ },
"account": {
"properties": {
"created_on": {
@@ -824,7 +889,12 @@
"type": "string"
},
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
- "name": { "description": "Account name", "example": "Demo Account", "maxLength": 100, "type": "string" },
+ "name": {
+ "description": "Account name",
+ "example": "Demo Account",
+ "maxLength": 100,
+ "type": "string"
+ },
"settings": {
"description": "Account settings",
"properties": {
@@ -851,7 +921,10 @@
{
"properties": {
"result": {
- "properties": { "default_usage_model": { "readOnly": true }, "green_compute": { "readOnly": true } },
+ "properties": {
+ "default_usage_model": { "readOnly": true },
+ "green_compute": { "readOnly": true }
+ },
"type": "object"
}
}
@@ -863,7 +936,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/subscription" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -890,7 +968,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/acl_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/acl_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -898,11 +978,19 @@
]
},
"acl_components-schemas-identifier": { "example": "23ff594956f20c2a721606e94745a8aa" },
- "acl_components-schemas-name": { "description": "The name of the acl.", "example": "my-acl-1", "type": "string" },
+ "acl_components-schemas-name": {
+ "description": "The name of the acl.",
+ "example": "my-acl-1",
+ "type": "string"
+ },
"acl_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/acl" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/acl" }, "type": "array" }
+ }
+ }
]
},
"acl_components-schemas-single_response": {
@@ -915,7 +1003,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/CustomNS" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/CustomNS" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -923,7 +1013,10 @@
"acns_response_single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/CustomNS" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/CustomNS" } },
+ "type": "object"
+ }
]
},
"action": {
@@ -1020,7 +1113,13 @@
},
"activity-log-settings": {
"description": "Activity log settings.",
- "properties": { "enabled": { "description": "Enable activity logging.", "example": true, "type": "boolean" } },
+ "properties": {
+ "enabled": {
+ "description": "Enable activity logging.",
+ "example": true,
+ "type": "boolean"
+ }
+ },
"type": "object"
},
"adaptive_routing": {
@@ -1057,7 +1156,9 @@
"can_modify_ips": { "$ref": "#/components/schemas/can_modify_ips" },
"created_at": { "$ref": "#/components/schemas/timestamp" },
"default_sni": { "$ref": "#/components/schemas/default_sni" },
- "description": { "$ref": "#/components/schemas/address-maps_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/address-maps_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
"modified_at": { "$ref": "#/components/schemas/timestamp" }
},
@@ -1088,7 +1189,14 @@
"address-maps_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/address-maps" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/address-maps" },
+ "type": "array"
+ }
+ }
+ }
]
},
"address-maps_components-schemas-single_response": {
@@ -1102,7 +1210,10 @@
"example": "Suite 430",
"type": "string"
},
- "addresses": { "allOf": [{ "$ref": "#/components/schemas/destination_address_properties" }], "type": "object" },
+ "addresses": {
+ "allOf": [{ "$ref": "#/components/schemas/destination_address_properties" }],
+ "type": "object"
+ },
"advanced_certificate_pack_response_single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
@@ -1113,8 +1224,12 @@
"certificate_authority": { "$ref": "#/components/schemas/certificate_authority" },
"cloudflare_branding": { "$ref": "#/components/schemas/cloudflare_branding" },
"hosts": { "$ref": "#/components/schemas/schemas-hosts" },
- "id": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" },
- "status": { "$ref": "#/components/schemas/certificate-packs_components-schemas-status" },
+ "id": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier"
+ },
+ "status": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-status"
+ },
"type": { "$ref": "#/components/schemas/advanced_type" },
"validation_method": { "$ref": "#/components/schemas/validation_method" },
"validity_days": { "$ref": "#/components/schemas/validity_days" }
@@ -1131,7 +1246,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["advanced_ddos"], "example": "advanced_ddos" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["advanced_ddos"],
+ "example": "advanced_ddos"
+ },
"value": { "$ref": "#/components/schemas/advanced_ddos_value" }
}
}
@@ -1175,7 +1294,9 @@
},
"alert-types": {
"properties": {
- "description": { "$ref": "#/components/schemas/alert-types_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/alert-types_components-schemas-description"
+ },
"display_name": { "$ref": "#/components/schemas/display_name" },
"filter_options": { "$ref": "#/components/schemas/schemas-filter_options" },
"type": { "$ref": "#/components/schemas/alert-types_components-schemas-type" }
@@ -1193,7 +1314,10 @@
{
"properties": {
"result": {
- "additionalProperties": { "items": { "$ref": "#/components/schemas/alert-types" }, "type": "array" },
+ "additionalProperties": {
+ "items": { "$ref": "#/components/schemas/alert-types" },
+ "type": "array"
+ },
"example": {
"Origin Monitoring": [
{
@@ -1229,7 +1353,11 @@
"type": "string"
},
"algo": { "description": "TSIG algorithm.", "example": "hmac-sha512.", "type": "string" },
- "allow_all_headers": { "description": "Allows all HTTP request headers.", "example": true, "type": "boolean" },
+ "allow_all_headers": {
+ "description": "Allows all HTTP request headers.",
+ "example": true,
+ "type": "boolean"
+ },
"allow_all_methods": { "description": "Allows all HTTP request methods.", "type": "boolean" },
"allow_all_origins": { "description": "Allows all origins.", "type": "boolean" },
"allow_credentials": {
@@ -1269,7 +1397,11 @@
"items": { "type": "string" },
"type": "array"
},
- "allowed_headers": { "description": "Allowed HTTP request headers.", "items": {}, "type": "array" },
+ "allowed_headers": {
+ "description": "Allowed HTTP request headers.",
+ "items": {},
+ "type": "array"
+ },
"allowed_idps": {
"description": "The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.",
"items": {
@@ -1332,7 +1464,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["always_online"], "example": "always_online" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["always_online"],
+ "example": "always_online"
+ },
"value": { "$ref": "#/components/schemas/always_online_value" }
}
}
@@ -1404,7 +1540,11 @@
},
"type": "object"
},
- "timestamp": { "example": "2014-01-01T05:20:00.12345Z", "format": "date-time", "type": "string" }
+ "timestamp": {
+ "example": "2014-01-01T05:20:00.12345Z",
+ "format": "date-time",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -1417,7 +1557,11 @@
"analytics_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/analytics" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/analytics" }, "type": "array" }
+ }
+ }
]
},
"anomaly_description": {
@@ -1451,7 +1595,15 @@
}
}
],
- "required": ["id", "name", "description", "zone_id", "detection_mode", "sensitivity", "action_mode"],
+ "required": [
+ "id",
+ "name",
+ "description",
+ "zone_id",
+ "detection_mode",
+ "sensitivity",
+ "action_mode"
+ ],
"title": "Anomaly detection WAF package (OWASP)"
},
"anomaly_rule": {
@@ -1465,7 +1617,15 @@
}
],
"description": "When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.",
- "required": ["id", "description", "priority", "allowed_modes", "mode", "group", "package_id"],
+ "required": [
+ "id",
+ "description",
+ "priority",
+ "allowed_modes",
+ "mode",
+ "group",
+ "package_id"
+ ],
"title": "Anomaly detection WAF rule"
},
"anti-virus-settings": {
@@ -1493,7 +1653,9 @@
"properties": {
"errors": { "$ref": "#/components/schemas/messages" },
"messages": { "$ref": "#/components/schemas/messages" },
- "result": { "anyOf": [{ "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }] },
+ "result": {
+ "anyOf": [{ "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }]
+ },
"success": {
"description": "Whether the API call was successful",
"enum": [true],
@@ -1526,7 +1688,11 @@
"api-response-single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "anyOf": [{ "type": "object" }, { "type": "string" }], "nullable": true } } }
+ {
+ "properties": {
+ "result": { "anyOf": [{ "type": "object" }, { "type": "string" }], "nullable": true }
+ }
+ }
],
"type": "object"
},
@@ -1537,7 +1703,9 @@
"properties": {
"result": {
"nullable": true,
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"required": ["id"],
"type": "object"
}
@@ -1554,7 +1722,10 @@
"type": "boolean"
},
"app-types": {
- "oneOf": [{ "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/application_type" }],
+ "oneOf": [
+ { "$ref": "#/components/schemas/application" },
+ { "$ref": "#/components/schemas/application_type" }
+ ],
"readOnly": true,
"type": "object"
},
@@ -1566,7 +1737,11 @@
"app-types_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/app-types" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/app-types" }, "type": "array" }
+ }
+ }
]
},
"app_components-schemas-created": {
@@ -1608,7 +1783,11 @@
"properties": {
"domain": { "example": "authdomain.cloudflareaccess.com", "readOnly": true },
"name": { "default": "App Launcher", "example": "App Launcher", "readOnly": true },
- "type": { "description": "The application type.", "example": "app_launcher", "type": "string" }
+ "type": {
+ "description": "The application type.",
+ "example": "app_launcher",
+ "type": "string"
+ }
}
}
]
@@ -1664,7 +1843,10 @@
"items": {},
"type": "array"
},
- "email_list_uuid": { "description": "The UUID of an re-usable email list.", "type": "string" }
+ "email_list_uuid": {
+ "description": "The UUID of an re-usable email list.",
+ "type": "string"
+ }
},
"required": ["approvals_needed"],
"type": "object"
@@ -1672,7 +1854,10 @@
"approval_groups": {
"description": "Administrators who can approve a temporary authentication request.",
"example": [
- { "approvals_needed": 1, "email_addresses": ["test1@cloudflare.com", "test2@cloudflare.com"] },
+ {
+ "approvals_needed": 1,
+ "email_addresses": ["test1@cloudflare.com", "test2@cloudflare.com"]
+ },
{ "approvals_needed": 3, "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34" }
],
"items": { "$ref": "#/components/schemas/approval_group" },
@@ -1762,7 +1947,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -1776,13 +1964,24 @@
"apps_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/apps" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/apps" }, "type": "array" }
+ }
+ }
]
},
"apps_components-schemas-response_collection-2": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-apps" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-apps" },
+ "type": "array"
+ }
+ }
+ }
]
},
"apps_components-schemas-single_response": {
@@ -1799,7 +1998,17 @@
},
"apps_components-schemas-type": {
"description": "The application type.",
- "enum": ["self_hosted", "saas", "ssh", "vnc", "app_launcher", "warp", "biso", "bookmark", "dash_sso"],
+ "enum": [
+ "self_hosted",
+ "saas",
+ "ssh",
+ "vnc",
+ "app_launcher",
+ "warp",
+ "biso",
+ "bookmark",
+ "dash_sso"
+ ],
"example": "self_hosted",
"type": "string"
},
@@ -1815,7 +2024,9 @@
"items": { "$ref": "#/components/schemas/argo-tunnel_components-schemas-connection" },
"type": "array"
},
- "created_at": { "description": "Timestamps when the tunnel was created, formatted in RFC 3339." },
+ "created_at": {
+ "description": "Timestamps when the tunnel was created, formatted in RFC 3339."
+ },
"deleted_at": {
"description": "If present, indicates tunnel was deleted at the given date (formatted in RFC 3339). If absent, tunnel has not been deleted.",
"example": "2009-11-10T23:00:00Z",
@@ -1867,7 +2078,11 @@
"country": { "$ref": "#/components/schemas/asn_country" },
"description": { "$ref": "#/components/schemas/asn_description" },
"domain_count": { "type": "integer" },
- "top_domains": { "example": ["example.com"], "items": { "type": "string" }, "type": "array" },
+ "top_domains": {
+ "example": ["example.com"],
+ "items": { "type": "string" },
+ "type": "array"
+ },
"type": { "$ref": "#/components/schemas/asn_type" }
}
},
@@ -1876,7 +2091,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/asn_components-schemas-asn" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/asn_components-schemas-asn" },
+ "type": "array"
+ }
}
}
]
@@ -1888,7 +2106,11 @@
"enum": ["asn"],
"example": "asn"
},
- "value": { "description": "The AS number to match.", "example": "AS12345", "type": "string" }
+ "value": {
+ "description": "The AS number to match.",
+ "example": "AS12345",
+ "type": "string"
+ }
},
"title": "An ASN configuration."
},
@@ -1983,10 +2205,19 @@
"example": "d5b0f326-1232-4452-8858-1089bd7168ef",
"type": "string"
},
- "interface": { "description": "The source of the event.", "example": "API", "type": "string" },
+ "interface": {
+ "description": "The source of the event.",
+ "example": "API",
+ "type": "string"
+ },
"metadata": {
"description": "An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.",
- "example": { "name": "security_level", "type": "firewall", "value": "high", "zone_name": "example.com" },
+ "example": {
+ "name": "security_level",
+ "type": "firewall",
+ "value": "high",
+ "zone_name": "example.com"
+ },
"type": "object"
},
"newValue": {
@@ -2000,7 +2231,9 @@
"type": "string"
},
"owner": {
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"type": "object"
},
"resource": {
@@ -2132,7 +2365,14 @@
"type": "boolean"
}
},
- "required": ["enabled", "cf", "wordpress", "wp_plugin", "hostnames", "cache_by_device_type"],
+ "required": [
+ "enabled",
+ "cf",
+ "wordpress",
+ "wp_plugin",
+ "hostnames",
+ "cache_by_device_type"
+ ],
"type": "object"
},
"availability_response": {
@@ -2202,14 +2442,23 @@
"bandwidth": {
"description": "Breakdown of totals for bandwidth in the form of bytes.",
"properties": {
- "all": { "description": "The total number of bytes served within the time frame.", "type": "integer" },
+ "all": {
+ "description": "The total number of bytes served within the time frame.",
+ "type": "integer"
+ },
"cached": {
"description": "The number of bytes that were cached (and served) by Cloudflare.",
"type": "integer"
},
"content_type": {
"description": "A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.",
- "example": { "css": 237421, "gif": 1234242, "html": 1231290, "javascript": 123245, "jpeg": 784278 },
+ "example": {
+ "css": 237421,
+ "gif": 1234242,
+ "html": 1231290,
+ "javascript": 123245,
+ "jpeg": 784278
+ },
"type": "object"
},
"country": {
@@ -2220,19 +2469,40 @@
"ssl": {
"description": "A break down of bytes served over HTTPS.",
"properties": {
- "encrypted": { "description": "The number of bytes served over HTTPS.", "type": "integer" },
- "unencrypted": { "description": "The number of bytes served over HTTP.", "type": "integer" }
+ "encrypted": {
+ "description": "The number of bytes served over HTTPS.",
+ "type": "integer"
+ },
+ "unencrypted": {
+ "description": "The number of bytes served over HTTP.",
+ "type": "integer"
+ }
},
"type": "object"
},
"ssl_protocols": {
"description": "A breakdown of requests by their SSL protocol.",
"properties": {
- "TLSv1": { "description": "The number of requests served over TLS v1.0.", "type": "integer" },
- "TLSv1.1": { "description": "The number of requests served over TLS v1.1.", "type": "integer" },
- "TLSv1.2": { "description": "The number of requests served over TLS v1.2.", "type": "integer" },
- "TLSv1.3": { "description": "The number of requests served over TLS v1.3.", "type": "integer" },
- "none": { "description": "The number of requests served over HTTP.", "type": "integer" }
+ "TLSv1": {
+ "description": "The number of requests served over TLS v1.0.",
+ "type": "integer"
+ },
+ "TLSv1.1": {
+ "description": "The number of requests served over TLS v1.1.",
+ "type": "integer"
+ },
+ "TLSv1.2": {
+ "description": "The number of requests served over TLS v1.2.",
+ "type": "integer"
+ },
+ "TLSv1.3": {
+ "description": "The number of requests served over TLS v1.3.",
+ "type": "integer"
+ },
+ "none": {
+ "description": "The number of requests served over HTTP.",
+ "type": "integer"
+ }
},
"type": "object"
},
@@ -2246,7 +2516,10 @@
"bandwidth_by_colo": {
"description": "Breakdown of totals for bandwidth in the form of bytes.",
"properties": {
- "all": { "description": "The total number of bytes served within the time frame.", "type": "integer" },
+ "all": {
+ "description": "The total number of bytes served within the time frame.",
+ "type": "integer"
+ },
"cached": {
"description": "The number of bytes that were cached (and served) by Cloudflare.",
"type": "integer"
@@ -2322,7 +2595,16 @@
"type": { "$ref": "#/components/schemas/type" },
"zone": { "$ref": "#/components/schemas/schemas-zone" }
},
- "required": ["id", "type", "action", "description", "occurred_at", "amount", "currency", "zone"],
+ "required": [
+ "id",
+ "type",
+ "action",
+ "description",
+ "occurred_at",
+ "amount",
+ "currency",
+ "zone"
+ ],
"type": "object"
},
"billing-history_components-schemas-identifier": {
@@ -2336,7 +2618,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/billing-history" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/billing-history" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -2369,7 +2656,11 @@
"example": "Clientless Web Isolation",
"readOnly": true
},
- "type": { "description": "The application type.", "example": "biso", "type": "string" }
+ "type": {
+ "description": "The application type.",
+ "example": "biso",
+ "type": "string"
+ }
}
}
]
@@ -2377,14 +2668,25 @@
"block-page-settings": {
"description": "Block page layout settings.",
"properties": {
- "background_color": { "description": "Block page background color in #rrggbb format.", "type": "string" },
+ "background_color": {
+ "description": "Block page background color in #rrggbb format.",
+ "type": "string"
+ },
"enabled": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
},
- "footer_text": { "description": "Block page footer text.", "example": "--footer--", "type": "string" },
- "header_text": { "description": "Block page header text.", "example": "--header--", "type": "string" },
+ "footer_text": {
+ "description": "Block page footer text.",
+ "example": "--footer--",
+ "type": "string"
+ },
+ "header_text": {
+ "description": "Block page header text.",
+ "example": "--header--",
+ "type": "string"
+ },
"logo_path": {
"description": "Full URL to the logo file.",
"example": "https://logos.com/a.png",
@@ -2418,10 +2720,17 @@
"bookmark_props": {
"properties": {
"app_launcher_visible": { "default": true },
- "domain": { "description": "The URL or domain of the bookmark.", "example": "https://mybookmark.com" },
+ "domain": {
+ "description": "The URL or domain of the bookmark.",
+ "example": "https://mybookmark.com"
+ },
"logo_url": { "$ref": "#/components/schemas/logo_url" },
"name": { "$ref": "#/components/schemas/apps_components-schemas-name" },
- "type": { "description": "The application type.", "example": "bookmark", "type": "string" }
+ "type": {
+ "description": "The application type.",
+ "example": "bookmark",
+ "type": "string"
+ }
},
"title": "Bookmark application",
"type": "object"
@@ -2443,7 +2752,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -2457,7 +2769,11 @@
"bookmarks_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/bookmarks" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/bookmarks" }, "type": "array" }
+ }
+ }
]
},
"bookmarks_components-schemas-single_response": {
@@ -2482,7 +2798,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["brotli"], "example": "brotli" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["brotli"],
+ "example": "brotli"
+ },
"value": { "$ref": "#/components/schemas/brotli_value" }
}
}
@@ -2528,8 +2848,9 @@
"default": 14400,
"description": "Value of the zone setting.\nNotes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`",
"enum": [
- 0, 30, 60, 120, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800,
- 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000
+ 0, 30, 60, 120, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600,
+ 72000, 86400, 172800, 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800,
+ 16070400, 31536000
],
"type": "number"
},
@@ -2538,7 +2859,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["browser_check"], "example": "browser_check" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["browser_check"],
+ "example": "browser_check"
+ },
"value": { "$ref": "#/components/schemas/browser_check_value" }
}
}
@@ -2603,7 +2928,10 @@
"bulk-operation-response-collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "$ref": "#/components/schemas/schemas-operation" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/schemas-operation" } },
+ "type": "object"
+ }
]
},
"bulk_delete": { "items": { "$ref": "#/components/schemas/key_name_bulk" }, "type": "array" },
@@ -2643,7 +2971,11 @@
"items": {
"properties": {
"name": { "enum": ["url"], "example": "url", "type": "string" },
- "value": { "description": "The URL to bypass.", "example": "api.example.com/*", "type": "string" }
+ "value": {
+ "description": "The URL to bypass.",
+ "example": "api.example.com/*",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -2680,7 +3012,11 @@
"ca_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/ca" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/ca" }, "type": "array" }
+ }
+ }
]
},
"ca_components-schemas-single_response": {
@@ -2694,7 +3030,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["cache_level"], "example": "cache_level" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["cache_level"],
+ "example": "cache_level"
+ },
"value": { "$ref": "#/components/schemas/cache_level_value" }
}
}
@@ -2713,7 +3053,11 @@
{ "$ref": "#/components/schemas/components-schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["cache_reserve"], "example": "cache_reserve" }
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["cache_reserve"],
+ "example": "cache_reserve"
+ }
}
}
],
@@ -2865,13 +3209,24 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-categories" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-categories" },
+ "type": "array"
+ }
}
}
]
},
- "category": { "description": "A category of the rule.", "example": "directory-traversal", "type": "string" },
- "categoryAlias": { "description": "Special Event Category alias", "example": "videos", "type": "string" },
+ "category": {
+ "description": "A category of the rule.",
+ "example": "directory-traversal",
+ "type": "string"
+ },
+ "categoryAlias": {
+ "description": "Special Event Category alias",
+ "example": "videos",
+ "type": "string"
+ },
"cert_pack_uuid": {
"description": "Certificate Pack UUID.",
"example": "a77f8bd7-3b47-46b4-a6f1-75cf98109948",
@@ -2921,11 +3276,17 @@
"certificate": {
"$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"
},
- "expires_on": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on" },
- "id": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" },
+ "expires_on": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on"
+ },
+ "id": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"
+ },
"issuer": { "$ref": "#/components/schemas/issuer" },
"signature": { "$ref": "#/components/schemas/signature" },
- "status": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-status" },
+ "status": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-status"
+ },
"uploaded_on": { "$ref": "#/components/schemas/schemas-uploaded_on" }
}
},
@@ -2946,7 +3307,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "advanced": { "$ref": "#/components/schemas/quota" } }, "type": "object" }
+ "result": {
+ "properties": { "advanced": { "$ref": "#/components/schemas/quota" } },
+ "type": "object"
+ }
},
"type": "object"
}
@@ -2969,7 +3333,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/custom-certificate" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/custom-certificate" },
+ "type": "array"
+ }
}
}
]
@@ -2981,7 +3348,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -3001,7 +3370,11 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" } }
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/certificates_components-schemas-identifier"
+ }
+ }
}
}
}
@@ -3017,7 +3390,15 @@
},
"certificate_status": {
"description": "Current status of certificate.",
- "enum": ["initializing", "authorizing", "active", "expired", "issuing", "timing_out", "pending_deployment"],
+ "enum": [
+ "initializing",
+ "authorizing",
+ "active",
+ "expired",
+ "issuing",
+ "timing_out",
+ "pending_deployment"
+ ],
"example": "active",
"type": "string"
},
@@ -3025,7 +3406,9 @@
"properties": {
"certificate": { "$ref": "#/components/schemas/components-schemas-certificate" },
"csr": { "$ref": "#/components/schemas/csr" },
- "expires_on": { "$ref": "#/components/schemas/certificates_components-schemas-expires_on" },
+ "expires_on": {
+ "$ref": "#/components/schemas/certificates_components-schemas-expires_on"
+ },
"hostnames": { "$ref": "#/components/schemas/hostnames" },
"id": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" },
"request_type": { "$ref": "#/components/schemas/request_type" },
@@ -3046,7 +3429,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -3067,7 +3453,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-certificates" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-certificates" },
+ "type": "array"
+ }
}
}
]
@@ -3089,7 +3478,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["challenge_ttl"], "example": "challenge_ttl" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["challenge_ttl"],
+ "example": "challenge_ttl"
+ },
"value": { "$ref": "#/components/schemas/challenge_ttl_value" }
}
}
@@ -3100,7 +3493,10 @@
"challenge_ttl_value": {
"default": 1800,
"description": "Value of the zone setting.",
- "enum": [300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000],
+ "enum": [
+ 300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000,
+ 31536000
+ ],
"type": "number"
},
"characteristics": {
@@ -3171,7 +3567,11 @@
"cidr_list": {
"description": "List of IPv4/IPv6 CIDR addresses.",
"example": ["199.27.128.0/21", "2400:cb00::/32"],
- "items": { "description": "IPv4/IPv6 CIDR.", "example": "199.27.128.0/21", "type": "string" },
+ "items": {
+ "description": "IPv4/IPv6 CIDR.",
+ "example": "199.27.128.0/21",
+ "type": "string"
+ },
"type": "array"
},
"ciphers": {
@@ -3179,7 +3579,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["ciphers"], "example": "ciphers" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["ciphers"],
+ "example": "ciphers"
+ },
"value": { "$ref": "#/components/schemas/ciphers_value" }
}
}
@@ -3241,7 +3645,9 @@
"cloudflare-tunnel_components-schemas-connection": {
"properties": {
"client_id": { "description": "UUID of the cloudflared instance." },
- "client_version": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-version" },
+ "client_version": {
+ "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-version"
+ },
"colo_name": {
"description": "Short ID for the colo this connection is connected to.",
"example": "DFW",
@@ -3337,7 +3743,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/invite" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/invite" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -3347,7 +3755,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/components-schemas-member" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/components-schemas-member" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -3357,7 +3768,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/membership" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/membership" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -3366,7 +3779,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/organization" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/organization" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -3380,7 +3798,10 @@
"messages": { "items": {}, "type": "array" },
"result": {
"items": {
- "allOf": [{ "$ref": "#/components/schemas/api-shield" }, { "properties": { "features": {} } }]
+ "allOf": [
+ { "$ref": "#/components/schemas/api-shield" },
+ { "properties": { "features": {} } }
+ ]
},
"type": "array"
}
@@ -3423,7 +3844,12 @@
}
},
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/api-shield" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/api-shield" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -3434,7 +3860,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-role" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-role" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -3446,7 +3877,11 @@
},
"type": "object"
},
- "colo_city": { "description": "Source colo city.", "example": "Denver, CO, US", "type": "string" },
+ "colo_city": {
+ "description": "Source colo city.",
+ "example": "Denver, CO, US",
+ "type": "string"
+ },
"colo_name": { "description": "Source colo name.", "example": "den01", "type": "string" },
"colo_names": {
"description": "List of colo names for the ECMP scope.",
@@ -3513,7 +3948,10 @@
"type": "string"
},
"common_components-schemas-ip": {
- "anyOf": [{ "$ref": "#/components/schemas/ipv4" }, { "$ref": "#/components/schemas/schemas-ipv6" }]
+ "anyOf": [
+ { "$ref": "#/components/schemas/ipv4" },
+ { "$ref": "#/components/schemas/schemas-ipv6" }
+ ]
},
"common_components-schemas-modified_on": {
"description": "The date and time the tunnel was last modified.",
@@ -3538,10 +3976,26 @@
"component_value": {
"description": "A component value for a subscription.",
"properties": {
- "default": { "description": "The default amount assigned.", "example": 5, "type": "number" },
- "name": { "description": "The name of the component value.", "example": "page_rules", "type": "string" },
- "price": { "description": "The unit price for the component value.", "example": 5, "type": "number" },
- "value": { "description": "The amount of the component value assigned.", "example": 20, "type": "number" }
+ "default": {
+ "description": "The default amount assigned.",
+ "example": 5,
+ "type": "number"
+ },
+ "name": {
+ "description": "The name of the component value.",
+ "example": "page_rules",
+ "type": "string"
+ },
+ "price": {
+ "description": "The unit price for the component value.",
+ "example": 5,
+ "type": "number"
+ },
+ "value": {
+ "description": "The amount of the component value assigned.",
+ "example": 20,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -3572,7 +4026,11 @@
"description": "The action to perform when the threshold of matched traffic within the configured period is exceeded.",
"type": "object"
},
- "components-schemas-address": { "description": "Address.", "example": "123 Sesame St.", "type": "string" },
+ "components-schemas-address": {
+ "description": "Address.",
+ "example": "123 Sesame St.",
+ "type": "string"
+ },
"components-schemas-app_id": {
"description": "The identifier for this application. There is only one application per id.",
"type": "integer"
@@ -3580,7 +4038,11 @@
"components-schemas-asn": { "type": "integer" },
"components-schemas-base": {
"properties": {
- "id": { "description": "Identifier of the zone setting.", "example": "development_mode", "type": "string" },
+ "id": {
+ "description": "Identifier of the zone setting.",
+ "example": "development_mode",
+ "type": "string"
+ },
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
@@ -3603,7 +4065,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/zone-authenticated-origin-pull" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/zone-authenticated-origin-pull" },
+ "type": "array"
+ }
}
}
]
@@ -3611,13 +4076,22 @@
"components-schemas-certificate_response_single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/schemas-certificateObject" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/schemas-certificateObject" } }
+ }
]
},
"components-schemas-collection_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/web3-hostname" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/web3-hostname" },
+ "type": "array"
+ }
+ }
+ }
]
},
"components-schemas-configuration": {
@@ -3692,7 +4166,10 @@
"example": true,
"type": "boolean"
},
- "components-schemas-exclude": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" },
+ "components-schemas-exclude": {
+ "items": { "$ref": "#/components/schemas/split_tunnel" },
+ "type": "array"
+ },
"components-schemas-expires_on": {
"description": "When the certificate from the authority expires.",
"example": "2016-01-01T05:20:00Z",
@@ -3738,7 +4215,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/tsig_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/tsig_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -3879,7 +4358,11 @@
"components-schemas-pattern": {
"description": "A pattern that matches an entry",
"properties": {
- "regex": { "description": "The regex pattern.", "example": "^4[0-9]{6,}$", "type": "string" },
+ "regex": {
+ "description": "The regex pattern.",
+ "example": "^4[0-9]{6,}$",
+ "type": "string"
+ },
"validation": {
"description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.",
"enum": ["luhn"],
@@ -3963,7 +4446,11 @@
"components-schemas-response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/ip-list" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/ip-list" }, "type": "array" }
+ }
+ }
]
},
"components-schemas-response_collection": {
@@ -3971,7 +4458,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/zone_components-schemas-zone" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/zone_components-schemas-zone" },
+ "type": "array"
+ }
}
}
]
@@ -4027,7 +4517,9 @@
"phase": { "example": "http_custom_errors" },
"rules": {
"description": "The rules in the ruleset.",
- "items": { "$ref": "#/components/schemas/custom-error-responses_components-schemas-rule" },
+ "items": {
+ "$ref": "#/components/schemas/custom-error-responses_components-schemas-rule"
+ },
"type": "array"
}
}
@@ -4083,7 +4575,9 @@
},
"components-schemas-tunnel_update_request": {
"properties": {
- "description": { "$ref": "#/components/schemas/interconnect_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/interconnect_components-schemas-description"
+ },
"gre": { "$ref": "#/components/schemas/gre" },
"interface_address": { "$ref": "#/components/schemas/interface_address" },
"mtu": { "$ref": "#/components/schemas/schemas-mtu" }
@@ -4097,7 +4591,10 @@
"properties": {
"result": {
"properties": {
- "interconnects": { "items": { "$ref": "#/components/schemas/interconnect" }, "type": "array" }
+ "interconnects": {
+ "items": { "$ref": "#/components/schemas/interconnect" },
+ "type": "array"
+ }
}
}
}
@@ -4134,11 +4631,17 @@
"type": "string"
},
"components-schemas-validation_method": {
- "properties": { "validation_method": { "$ref": "#/components/schemas/validation_method_definition" } },
+ "properties": {
+ "validation_method": { "$ref": "#/components/schemas/validation_method_definition" }
+ },
"required": ["validation_method"],
"type": "object"
},
- "components-schemas-value": { "enum": ["flexible", "full", "strict"], "example": "strict", "type": "string" },
+ "components-schemas-value": {
+ "enum": ["flexible", "full", "strict"],
+ "example": "strict",
+ "type": "string"
+ },
"components-schemas-version": {
"description": "The version of the analyzed script.",
"properties": {
@@ -4227,9 +4730,17 @@
],
"type": "object"
},
- "condition": { "properties": { "request.ip": { "$ref": "#/components/schemas/request.ip" } }, "type": "object" },
- "config": { "items": { "$ref": "#/components/schemas/hostname_certid_input" }, "type": "array" },
- "config_components-schemas-account_identifier": { "example": "6f91088a406011ed95aed352566e8d4c" },
+ "condition": {
+ "properties": { "request.ip": { "$ref": "#/components/schemas/request.ip" } },
+ "type": "object"
+ },
+ "config": {
+ "items": { "$ref": "#/components/schemas/hostname_certid_input" },
+ "type": "array"
+ },
+ "config_components-schemas-account_identifier": {
+ "example": "6f91088a406011ed95aed352566e8d4c"
+ },
"config_request": {
"description": "The configuration object containing third party integration information.",
"example": {
@@ -4263,7 +4774,9 @@
]
},
"configuration": {
- "properties": { "auth_id_characteristics": { "$ref": "#/components/schemas/characteristics" } },
+ "properties": {
+ "auth_id_characteristics": { "$ref": "#/components/schemas/characteristics" }
+ },
"type": "object"
},
"configurations": {
@@ -4299,7 +4812,9 @@
"id": { "example": "c9ef84a6bf5e47138c75d95e2f933e8f" },
"last_seen_at": { "example": "2021-09-02T09:57:54Z" },
"page_urls": { "example": ["blog.cloudflare.com/page1", "blog.cloudflare.com/page2"] },
- "url": { "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js" },
+ "url": {
+ "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"
+ },
"url_contains_cdn_cgi_path": { "example": false }
}
},
@@ -4308,7 +4823,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-connection" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-connection" },
+ "type": "array"
+ }
}
}
]
@@ -4360,7 +4878,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/connection_components-schemas-identifier" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/connection_components-schemas-identifier" }
+ }
}
}
}
@@ -4369,7 +4889,11 @@
"connection_single_request": {
"properties": {
"enabled": { "$ref": "#/components/schemas/connection_components-schemas-enabled" },
- "zone": { "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } } }
+ "zone": {
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ }
+ }
},
"required": ["zone"],
"type": "object"
@@ -4496,11 +5020,28 @@
"state": { "$ref": "#/components/schemas/contacts_components-schemas-state" },
"zip": { "$ref": "#/components/schemas/zipcode" }
},
- "required": ["first_name", "last_name", "address", "city", "state", "zip", "country", "phone", "organization"],
+ "required": [
+ "first_name",
+ "last_name",
+ "address",
+ "city",
+ "state",
+ "zip",
+ "country",
+ "phone",
+ "organization"
+ ],
+ "type": "object"
+ },
+ "contacts": {
+ "allOf": [{ "$ref": "#/components/schemas/contact_properties" }],
"type": "object"
},
- "contacts": { "allOf": [{ "$ref": "#/components/schemas/contact_properties" }], "type": "object" },
- "contacts_components-schemas-state": { "description": "State.", "example": "TX", "type": "string" },
+ "contacts_components-schemas-state": {
+ "description": "State.",
+ "example": "TX",
+ "type": "string"
+ },
"content": { "description": "DNS record content.", "example": "127.0.0.1", "type": "string" },
"content_categories": {
"description": "Current content categories.",
@@ -4545,7 +5086,9 @@
{
"properties": {
"result": {
- "properties": { "entries": { "$ref": "#/components/schemas/content_list_entries" } },
+ "properties": {
+ "entries": { "$ref": "#/components/schemas/content_list_entries" }
+ },
"type": "object"
}
}
@@ -4632,7 +5175,12 @@
},
"type": "object"
},
- "count": { "description": "The number of items in the List.", "example": 20, "readOnly": true, "type": "number" },
+ "count": {
+ "description": "The number of items in the List.",
+ "example": 20,
+ "readOnly": true,
+ "type": "number"
+ },
"country": {
"description": "The country in which the user lives.",
"example": "US",
@@ -4680,7 +5228,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/custom_profile" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/custom_profile" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -4732,7 +5285,9 @@
},
"create_request": {
"properties": {
- "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-description"
+ },
"dnslink": { "$ref": "#/components/schemas/dnslink" },
"name": { "$ref": "#/components/schemas/web3-hostname_components-schemas-name" },
"target": { "$ref": "#/components/schemas/components-schemas-target" }
@@ -5091,9 +5646,17 @@
"description": "A custom entry that matches a profile",
"properties": {
"created_at": { "$ref": "#/components/schemas/timestamp" },
- "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" },
+ "enabled": {
+ "description": "Whether the entry is enabled or not.",
+ "example": true,
+ "type": "boolean"
+ },
"id": { "$ref": "#/components/schemas/entry_id" },
- "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" },
+ "name": {
+ "description": "The name of the entry.",
+ "example": "Credit card (Visa)",
+ "type": "string"
+ },
"pattern": { "$ref": "#/components/schemas/components-schemas-pattern" },
"profile_id": { "description": "ID of the parent profile" },
"updated_at": { "$ref": "#/components/schemas/timestamp" }
@@ -5105,7 +5668,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/custom-hostname" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/custom-hostname" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -5119,7 +5687,11 @@
"anyOf": [
{
"properties": {
- "key": { "description": "Unique metadata for this hostname.", "example": "value", "type": "string" }
+ "key": {
+ "description": "Unique metadata for this hostname.",
+ "example": "value",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -5169,7 +5741,11 @@
"type": "array"
},
"id": { "$ref": "#/components/schemas/profile_id" },
- "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" },
+ "name": {
+ "description": "The name of the profile.",
+ "example": "Generic CVV Card Number",
+ "type": "string"
+ },
"type": {
"description": "The type of the profile.",
"enum": ["custom"],
@@ -5184,7 +5760,11 @@
"custom_profile_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "allOf": [{ "$ref": "#/components/schemas/custom_profile" }] } } }
+ {
+ "properties": {
+ "result": { "allOf": [{ "$ref": "#/components/schemas/custom_profile" }] }
+ }
+ }
]
},
"custom_response": {
@@ -5219,7 +5799,9 @@
"hostname": { "$ref": "#/components/schemas/hostname" },
"id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" },
"ownership_verification": { "$ref": "#/components/schemas/ownership_verification" },
- "ownership_verification_http": { "$ref": "#/components/schemas/ownership_verification_http" },
+ "ownership_verification_http": {
+ "$ref": "#/components/schemas/ownership_verification_http"
+ },
"ssl": { "$ref": "#/components/schemas/schemas-ssl" },
"status": { "$ref": "#/components/schemas/custom-hostname_components-schemas-status" },
"verification_errors": { "$ref": "#/components/schemas/verification_errors" }
@@ -5319,7 +5901,11 @@
"default_device_settings_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "$ref": "#/components/schemas/default_device_settings_policy" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/default_device_settings_policy" }
+ }
+ }
]
},
"default_mode": {
@@ -5341,7 +5927,12 @@
"default_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "errors": { "items": {}, "type": "array" }, "messages": { "items": {}, "type": "array" } } }
+ {
+ "properties": {
+ "errors": { "items": {}, "type": "array" },
+ "messages": { "items": {}, "type": "array" }
+ }
+ }
]
},
"default_sni": {
@@ -5394,7 +5985,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -5479,22 +6072,43 @@
"example": {
"data": [
{ "line": "Cloning repository...", "ts": "2021-04-20T19:35:29.0749819Z" },
- { "line": "From https://github.com/cloudflare/example", "ts": "2021-04-20T19:35:30.0749819Z" },
+ {
+ "line": "From https://github.com/cloudflare/example",
+ "ts": "2021-04-20T19:35:30.0749819Z"
+ },
{
"line": " * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -\u003e FETCH_HEAD",
"ts": "2021-04-20T19:35:30.0749819Z"
},
{ "line": "", "ts": "2021-04-20T19:35:30.0749819Z" },
- { "line": "HEAD is now at 209c5bb Update index.html", "ts": "2021-04-20T19:35:30.0749819Z" },
+ {
+ "line": "HEAD is now at 209c5bb Update index.html",
+ "ts": "2021-04-20T19:35:30.0749819Z"
+ },
{ "line": "", "ts": "2021-04-20T19:35:30.0749819Z" },
{ "line": "", "ts": "2021-04-20T19:35:30.0749819Z" },
- { "line": "Success: Finished cloning repository files", "ts": "2021-04-20T19:35:30.0749819Z" },
+ {
+ "line": "Success: Finished cloning repository files",
+ "ts": "2021-04-20T19:35:30.0749819Z"
+ },
{ "line": "Installing dependencies", "ts": "2021-04-20T19:35:59.0749819Z" },
{ "line": "Python version set to 2.7", "ts": "2021-04-20T19:35:59.0931208Z" },
- { "line": "v12.18.0 is already installed.", "ts": "2021-04-20T19:36:02.2369501Z" },
- { "line": "Now using node v12.18.0 (npm v6.14.4)", "ts": "2021-04-20T19:36:02.6028886Z" },
- { "line": "Started restoring cached build plugins", "ts": "2021-04-20T19:36:02.624555Z" },
- { "line": "Finished restoring cached build plugins", "ts": "2021-04-20T19:36:02.6340688Z" },
+ {
+ "line": "v12.18.0 is already installed.",
+ "ts": "2021-04-20T19:36:02.2369501Z"
+ },
+ {
+ "line": "Now using node v12.18.0 (npm v6.14.4)",
+ "ts": "2021-04-20T19:36:02.6028886Z"
+ },
+ {
+ "line": "Started restoring cached build plugins",
+ "ts": "2021-04-20T19:36:02.624555Z"
+ },
+ {
+ "line": "Finished restoring cached build plugins",
+ "ts": "2021-04-20T19:36:02.6340688Z"
+ },
{
"line": "Attempting ruby version 2.7.1, read from environment",
"ts": "2021-04-20T19:36:02.963095Z"
@@ -5508,17 +6122,32 @@
"line": "Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z",
"ts": "2021-04-20T19:36:05.4786868Z"
},
- { "line": "Started restoring cached go cache", "ts": "2021-04-20T19:36:05.4794366Z" },
- { "line": "Finished restoring cached go cache", "ts": "2021-04-20T19:36:05.481977Z" },
- { "line": "go version go1.14.4 linux/amd64", "ts": "2021-04-20T19:36:05.9049776Z" },
- { "line": "go version go1.14.4 linux/amd64", "ts": "2021-04-20T19:36:05.9086053Z" },
+ {
+ "line": "Started restoring cached go cache",
+ "ts": "2021-04-20T19:36:05.4794366Z"
+ },
+ {
+ "line": "Finished restoring cached go cache",
+ "ts": "2021-04-20T19:36:05.481977Z"
+ },
+ {
+ "line": "go version go1.14.4 linux/amd64",
+ "ts": "2021-04-20T19:36:05.9049776Z"
+ },
+ {
+ "line": "go version go1.14.4 linux/amd64",
+ "ts": "2021-04-20T19:36:05.9086053Z"
+ },
{ "line": "Installing missing commands", "ts": "2021-04-20T19:36:05.9163568Z" },
{ "line": "Verify run directory", "ts": "2021-04-20T19:36:05.9163934Z" },
{
"line": "Executing user command: echo \"skipping build step: no build command specified\"",
"ts": "2021-04-20T19:36:05.9164636Z"
},
- { "line": "skipping build step: no build command specified", "ts": "2021-04-20T19:36:05.9165087Z" },
+ {
+ "line": "skipping build step: no build command specified",
+ "ts": "2021-04-20T19:36:05.9165087Z"
+ },
{ "line": "Finished", "ts": "2021-04-20T19:36:05.917412Z" }
],
"includes_container_logs": true,
@@ -5538,8 +6167,16 @@
"result": {
"example": {
"data": [
- { "id": 15, "message": "Installing dependencies", "timestamp": "2021-04-20T19:35:59.0749819Z" },
- { "id": 16, "message": "Python version set to 2.7", "timestamp": "2021-04-20T19:35:59.0931208Z" },
+ {
+ "id": 15,
+ "message": "Installing dependencies",
+ "timestamp": "2021-04-20T19:35:59.0749819Z"
+ },
+ {
+ "id": 16,
+ "message": "Python version set to 2.7",
+ "timestamp": "2021-04-20T19:35:59.0931208Z"
+ },
{
"id": 17,
"message": "v12.18.0 is already installed.",
@@ -5565,11 +6202,31 @@
"message": "Attempting ruby version 2.7.1, read from environment",
"timestamp": "2021-04-20T19:36:02.963095Z"
},
- { "id": 22, "message": "Using ruby version 2.7.1", "timestamp": "2021-04-20T19:36:04.2236084Z" },
- { "id": 23, "message": "Using PHP version 5.6", "timestamp": "2021-04-20T19:36:04.5450152Z" },
- { "id": 24, "message": "5.2 is already installed.", "timestamp": "2021-04-20T19:36:04.5740509Z" },
- { "id": 25, "message": "Using Swift version 5.2", "timestamp": "2021-04-20T19:36:04.577035Z" },
- { "id": 26, "message": "Installing Hugo 0.54.0", "timestamp": "2021-04-20T19:36:04.5771615Z" },
+ {
+ "id": 22,
+ "message": "Using ruby version 2.7.1",
+ "timestamp": "2021-04-20T19:36:04.2236084Z"
+ },
+ {
+ "id": 23,
+ "message": "Using PHP version 5.6",
+ "timestamp": "2021-04-20T19:36:04.5450152Z"
+ },
+ {
+ "id": 24,
+ "message": "5.2 is already installed.",
+ "timestamp": "2021-04-20T19:36:04.5740509Z"
+ },
+ {
+ "id": 25,
+ "message": "Using Swift version 5.2",
+ "timestamp": "2021-04-20T19:36:04.577035Z"
+ },
+ {
+ "id": 26,
+ "message": "Installing Hugo 0.54.0",
+ "timestamp": "2021-04-20T19:36:04.5771615Z"
+ },
{
"id": 27,
"message": "Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z",
@@ -5595,8 +6252,16 @@
"message": "go version go1.14.4 linux/amd64",
"timestamp": "2021-04-20T19:36:05.9086053Z"
},
- { "id": 32, "message": "Installing missing commands", "timestamp": "2021-04-20T19:36:05.9163568Z" },
- { "id": 33, "message": "Verify run directory", "timestamp": "2021-04-20T19:36:05.9163934Z" },
+ {
+ "id": 32,
+ "message": "Installing missing commands",
+ "timestamp": "2021-04-20T19:36:05.9163568Z"
+ },
+ {
+ "id": 33,
+ "message": "Verify run directory",
+ "timestamp": "2021-04-20T19:36:05.9163934Z"
+ },
{
"id": 34,
"message": "Executing user command: echo \"skipping build step: no build command specified\"",
@@ -5684,7 +6349,11 @@
"description": "Environment variable.",
"example": { "value": "3.3" },
"properties": {
- "value": { "description": "Environment variable value.", "example": "3.3", "type": "string" }
+ "value": {
+ "description": "Environment variable value.",
+ "example": "3.3",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -5716,7 +6385,11 @@
"description": "R2 binding.",
"example": { "name": "some-bucket" },
"properties": {
- "name": { "description": "Name of the R2 bucket.", "example": "some-bucket", "type": "string" }
+ "name": {
+ "description": "Name of the R2 bucket.",
+ "example": "some-bucket",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -5784,7 +6457,11 @@
"description": "Environment variable.",
"example": { "value": "3.3" },
"properties": {
- "value": { "description": "Environment variable value.", "example": "3.3", "type": "string" }
+ "value": {
+ "description": "Environment variable value.",
+ "example": "3.3",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -5816,7 +6493,11 @@
"description": "R2 binding.",
"example": { "name": "some-bucket" },
"properties": {
- "name": { "description": "Name of the R2 bucket.", "example": "some-bucket", "type": "string" }
+ "name": {
+ "description": "Name of the R2 bucket.",
+ "example": "some-bucket",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -6083,10 +6764,16 @@
"device-posture-integrations": {
"properties": {
"config": { "$ref": "#/components/schemas/config_response" },
- "id": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid" },
+ "id": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid"
+ },
"interval": { "$ref": "#/components/schemas/schemas-interval" },
- "name": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type"
+ }
},
"type": "object"
},
@@ -6096,7 +6783,9 @@
{ "properties": { "result": { "nullable": true } } }
]
},
- "device-posture-integrations_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "device-posture-integrations_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"device-posture-integrations_components-schemas-name": {
"description": "The name of the Device Posture Integration.",
"example": "My Workspace One Integration",
@@ -6107,7 +6796,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/device-posture-integrations" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/device-posture-integrations" },
+ "type": "array"
+ }
}
}
]
@@ -6115,7 +6807,11 @@
"device-posture-integrations_components-schemas-single_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/device-posture-integrations" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/device-posture-integrations" }
+ }
+ }
]
},
"device-posture-integrations_components-schemas-type": {
@@ -6132,7 +6828,9 @@
},
"device-posture-rules": {
"properties": {
- "description": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-description"
+ },
"expiration": { "$ref": "#/components/schemas/schemas-expiration" },
"id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" },
"input": { "$ref": "#/components/schemas/schemas-input" },
@@ -6154,14 +6852,20 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" } },
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid"
+ }
+ },
"type": "object"
}
}
}
]
},
- "device-posture-rules_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "device-posture-rules_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"device-posture-rules_components-schemas-name": {
"description": "The name of the Device Posture Rule.",
"example": "Admin Serial Numbers",
@@ -6172,7 +6876,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/device-posture-rules" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/device-posture-rules" },
+ "type": "array"
+ }
}
}
]
@@ -6250,7 +6957,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/device_settings_policy" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/device_settings_policy" },
+ "type": "array"
+ }
}
}
]
@@ -6316,7 +7026,11 @@
"devices_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/devices" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/devices" }, "type": "array" }
+ }
+ }
]
},
"dimension_value": {
@@ -6324,7 +7038,10 @@
{
"description": "Dimension value, may contain dimension identifier for drill down.",
"properties": {
- "id": { "description": "Dimension value identifier that can be used for drill down.", "type": "string" },
+ "id": {
+ "description": "Dimension value identifier that can be used for drill down.",
+ "type": "string"
+ },
"name": { "description": "Dimension value.", "example": "NODATA", "type": "string" }
},
"required": ["name"],
@@ -6430,8 +7147,14 @@
"disable_for_time": {
"properties": {
"1": { "description": "Override code that is valid for 1 hour.", "example": "9106681" },
- "12": { "description": "Override code that is valid for 12 hour2.", "example": "3424359" },
- "24": { "description": "Override code that is valid for 24 hour.2.", "example": "2887634" },
+ "12": {
+ "description": "Override code that is valid for 12 hour2.",
+ "example": "3424359"
+ },
+ "24": {
+ "description": "Override code that is valid for 24 hour.2.",
+ "example": "2887634"
+ },
"3": { "description": "Override code that is valid for 3 hours.", "example": "5356247" },
"6": { "description": "Override code that is valid for 6 hours.", "example": "9478972" }
},
@@ -6465,7 +7188,11 @@
"readOnly": true,
"type": "string"
},
- "display_name": { "description": "Alert type name.", "example": "Origin Error Rate Alert", "type": "string" },
+ "display_name": {
+ "description": "Alert type name.",
+ "example": "Origin Error Rate Alert",
+ "type": "string"
+ },
"dlq_name": { "example": "example-dlq", "type": "string" },
"dns": {
"description": "The name and type of DNS record for the Spectrum application.",
@@ -6571,7 +7298,11 @@
"example": true,
"type": "boolean"
},
- "source": { "description": "Where the record originated from.", "example": "primary", "type": "string" }
+ "source": {
+ "description": "Where the record originated from.",
+ "example": "primary",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -6641,7 +7372,9 @@
"readOnly": true,
"type": "string"
},
- "dns-secondary-primary-zone_components-schemas-identifier": { "example": "269d8f4853475ca241c4e730be286b20" },
+ "dns-secondary-primary-zone_components-schemas-identifier": {
+ "example": "269d8f4853475ca241c4e730be286b20"
+ },
"dns-secondary-primary-zone_components-schemas-name": {
"description": "Zone name.",
"example": "www.example.com.",
@@ -6650,14 +7383,20 @@
"dns-secondary-secondary-zone": {
"properties": {
"auto_refresh_seconds": { "$ref": "#/components/schemas/auto_refresh_seconds" },
- "id": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" },
- "name": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-name" },
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ },
+ "name": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-name"
+ },
"peers": { "$ref": "#/components/schemas/peers" }
},
"required": ["id", "name", "peers", "auto_refresh_seconds"],
"type": "object"
},
- "dns-secondary-secondary-zone_components-schemas-identifier": { "example": "269d8f4853475ca241c4e730be286b20" },
+ "dns-secondary-secondary-zone_components-schemas-identifier": {
+ "example": "269d8f4853475ca241c4e730be286b20"
+ },
"dns-secondary-secondary-zone_components-schemas-name": {
"description": "Zone name.",
"example": "www.example.com.",
@@ -6668,7 +7407,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-dns-record" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-dns-record" },
+ "type": "array"
+ }
}
}
]
@@ -6696,7 +7438,14 @@
"dns_firewall_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/dns-firewall" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/dns-firewall" },
+ "type": "array"
+ }
+ }
+ }
]
},
"dns_firewall_single_response": {
@@ -6715,7 +7464,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/dns-record" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/dns-record" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -6727,7 +7478,11 @@
"properties": {
"result": {
"properties": {
- "recs_added": { "description": "Number of DNS records added.", "example": 5, "type": "number" },
+ "recs_added": {
+ "description": "Number of DNS records added.",
+ "example": 5,
+ "type": "number"
+ },
"total_records_parsed": {
"description": "Total number of DNS records parsed.",
"example": 5,
@@ -6858,7 +7613,11 @@
"domain_components-schemas-single_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/domain_components-schemas-domain" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/domain_components-schemas-domain" }
+ }
+ }
]
},
"domain_identifier": {
@@ -6897,7 +7656,11 @@
"domain_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/domains" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/domains" }, "type": "array" }
+ }
+ }
]
},
"domain_response_single": {
@@ -6911,7 +7674,11 @@
"properties": {
"email_domain": {
"properties": {
- "domain": { "description": "The email domain to match.", "example": "example.com", "type": "string" }
+ "domain": {
+ "description": "The email domain to match.",
+ "example": "example.com",
+ "type": "string"
+ }
},
"required": ["domain"],
"type": "object"
@@ -6930,9 +7697,14 @@
},
"type": "object"
},
- "domains": { "allOf": [{ "$ref": "#/components/schemas/domain_properties" }], "type": "object" },
+ "domains": {
+ "allOf": [{ "$ref": "#/components/schemas/domain_properties" }],
+ "type": "object"
+ },
"domains-post": { "example": { "name": "example.com" } },
- "domains_components-schemas-account_identifier": { "example": "9a7806061c88ada191ed06f989cc3dac" },
+ "domains_components-schemas-account_identifier": {
+ "example": "9a7806061c88ada191ed06f989cc3dac"
+ },
"downloadedFrom": {
"description": "The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.",
"example": "https://company.com/logo.png",
@@ -6945,13 +7717,21 @@
{ "properties": { "result": { "type": "object" } } }
]
},
- "duration": { "description": "The duration of the plan subscription.", "example": 1, "type": "number" },
+ "duration": {
+ "description": "The duration of the plan subscription.",
+ "example": 1,
+ "type": "number"
+ },
"early_hints": {
"allOf": [
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["early_hints"], "example": "early_hints" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["early_hints"],
+ "example": "early_hints"
+ },
"value": { "$ref": "#/components/schemas/early_hints_value" }
}
}
@@ -6996,8 +7776,8 @@
"default": 7200,
"description": "Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)",
"enum": [
- 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200,
- 345600, 432000, 518400, 604800
+ 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000,
+ 86400, 172800, 259200, 345600, 432000, 518400, 604800
],
"type": "number"
},
@@ -7027,7 +7807,11 @@
"ips": {
"description": "The array of customer owned IPs we broadcast via anycast for this hostname and application.",
"example": ["192.0.2.1"],
- "items": { "description": "Edge anycast IPs.", "example": "192.0.2.1", "type": "string" },
+ "items": {
+ "description": "Edge anycast IPs.",
+ "example": "192.0.2.1",
+ "type": "string"
+ },
"type": "array"
},
"type": {
@@ -7083,7 +7867,10 @@
{
"properties": {
"result": {
- "additionalProperties": { "items": { "$ref": "#/components/schemas/eligibility" }, "type": "array" },
+ "additionalProperties": {
+ "items": { "$ref": "#/components/schemas/eligibility" },
+ "type": "array"
+ },
"example": { "email": { "eligible": true, "ready": true, "type": "email" } },
"type": "object"
}
@@ -7160,7 +7947,10 @@
"empty_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": {}, "maxItems": 0, "type": "array" } }, "type": "object" }
+ {
+ "properties": { "result": { "items": {}, "maxItems": 0, "type": "array" } },
+ "type": "object"
+ }
]
},
"enable_binding_cookie": {
@@ -7179,7 +7969,11 @@
"example": "Enabled",
"type": "string"
},
- "enabled": { "description": "Flag that indicates if the job was enabled.", "example": false, "type": "boolean" },
+ "enabled": {
+ "description": "Flag that indicates if the job was enabled.",
+ "example": false,
+ "type": "boolean"
+ },
"enabled_download_phase": {
"description": "Set to enable antivirus scan on downloads.",
"example": false,
@@ -7219,7 +8013,10 @@
"pattern": "^/.*$",
"type": "string"
},
- "entities_components-schemas-asn": { "description": "Autonomous System Number (ASN).", "type": "integer" },
+ "entities_components-schemas-asn": {
+ "description": "Autonomous System Number (ASN).",
+ "type": "integer"
+ },
"entry_id": {
"allOf": [{ "$ref": "#/components/schemas/uuid" }],
"description": "The ID for this entry",
@@ -7256,7 +8053,11 @@
},
"estimated_queued_users": { "type": "integer" },
"estimated_total_active_users": { "type": "integer" },
- "eventAlias": { "description": "Special Event alias", "example": "eurovision-2022", "type": "string" },
+ "eventAlias": {
+ "description": "Special Event alias",
+ "example": "eurovision-2022",
+ "type": "string"
+ },
"event_custom_page_html": {
"description": "If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.",
"example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}",
@@ -7287,13 +8088,17 @@
"created_on": { "$ref": "#/components/schemas/timestamp" },
"custom_page_html": { "$ref": "#/components/schemas/event_details_custom_page_html" },
"description": { "$ref": "#/components/schemas/event_description" },
- "disable_session_renewal": { "$ref": "#/components/schemas/event_details_disable_session_renewal" },
+ "disable_session_renewal": {
+ "$ref": "#/components/schemas/event_details_disable_session_renewal"
+ },
"event_end_time": { "$ref": "#/components/schemas/event_end_time" },
"event_start_time": { "$ref": "#/components/schemas/event_start_time" },
"id": { "$ref": "#/components/schemas/event_id" },
"modified_on": { "$ref": "#/components/schemas/timestamp" },
"name": { "$ref": "#/components/schemas/event_name" },
- "new_users_per_minute": { "$ref": "#/components/schemas/event_details_new_users_per_minute" },
+ "new_users_per_minute": {
+ "$ref": "#/components/schemas/event_details_new_users_per_minute"
+ },
"prequeue_start_time": { "$ref": "#/components/schemas/event_prequeue_start_time" },
"queueing_method": { "$ref": "#/components/schemas/event_details_queueing_method" },
"session_duration": { "$ref": "#/components/schemas/event_details_session_duration" },
@@ -7321,7 +8126,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/event_id" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/event_id" } },
+ "type": "object"
+ }
}
}
]
@@ -7359,7 +8167,14 @@
"event_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/event_result" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/event_result" },
+ "type": "array"
+ }
+ }
+ }
]
},
"event_result": {
@@ -7367,7 +8182,9 @@
"created_on": { "$ref": "#/components/schemas/timestamp" },
"custom_page_html": { "$ref": "#/components/schemas/event_custom_page_html" },
"description": { "$ref": "#/components/schemas/event_description" },
- "disable_session_renewal": { "$ref": "#/components/schemas/event_disable_session_renewal" },
+ "disable_session_renewal": {
+ "$ref": "#/components/schemas/event_disable_session_renewal"
+ },
"event_end_time": { "$ref": "#/components/schemas/event_end_time" },
"event_start_time": { "$ref": "#/components/schemas/event_start_time" },
"id": { "$ref": "#/components/schemas/event_id" },
@@ -7415,7 +8232,11 @@
"everyone_rule": {
"description": "Matches everyone.",
"properties": {
- "everyone": { "description": "An empty object which matches on all users.", "example": {}, "type": "object" }
+ "everyone": {
+ "description": "An empty object which matches on all users.",
+ "example": {},
+ "type": "object"
+ }
},
"required": ["everyone"],
"title": "Everyone",
@@ -7536,18 +8357,28 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/fallback_domain" },
+ "type": "array"
+ }
+ }
}
]
},
- "fallback_domains": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" },
+ "fallback_domains": {
+ "items": { "$ref": "#/components/schemas/fallback_domain" },
+ "type": "array"
+ },
"fallback_origin_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
{ "properties": { "result": { "type": "object" } } }
]
},
- "fallback_pool": { "description": "The pool ID to use when all other pools are detected as unhealthy." },
+ "fallback_pool": {
+ "description": "The pool ID to use when all other pools are detected as unhealthy."
+ },
"fax": { "description": "Contact fax number.", "example": "123-867-5309", "type": "string" },
"feature_app_props": {
"properties": {
@@ -7560,13 +8391,20 @@
},
"type": "object"
},
- "features": { "anyOf": [{ "$ref": "#/components/schemas/thresholds" }], "readOnly": true, "type": "object" },
+ "features": {
+ "anyOf": [{ "$ref": "#/components/schemas/thresholds" }],
+ "readOnly": true,
+ "type": "object"
+ },
"fetched_at": {
"description": "The timestamp of when the script was last fetched.",
"nullable": true,
"type": "string"
},
- "fields_response": { "properties": { "key": { "example": "value", "type": "string" } }, "type": "object" },
+ "fields_response": {
+ "properties": { "key": { "example": "value", "type": "string" } },
+ "type": "object"
+ },
"filename": {
"description": "Image file name.",
"example": "logo.png",
@@ -7592,7 +8430,10 @@
"properties": {
"result": {
"items": {
- "allOf": [{ "$ref": "#/components/schemas/filter" }, { "required": ["id"], "type": "object" }]
+ "allOf": [
+ { "$ref": "#/components/schemas/filter" },
+ { "required": ["id"], "type": "object" }
+ ]
},
"type": "array"
}
@@ -7607,7 +8448,10 @@
{
"properties": {
"result": {
- "allOf": [{ "$ref": "#/components/schemas/filter" }, { "required": ["id"], "type": "object" }]
+ "allOf": [
+ { "$ref": "#/components/schemas/filter" },
+ { "required": ["id"], "type": "object" }
+ ]
}
},
"required": ["result"],
@@ -7625,7 +8469,11 @@
"filter-response-collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/filters" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/filters" }, "type": "array" }
+ }
+ }
]
},
"filter-response-single": {
@@ -7637,7 +8485,9 @@
"filter-rule-base": {
"properties": {
"action": { "$ref": "#/components/schemas/firewall-rules_components-schemas-action" },
- "description": { "$ref": "#/components/schemas/firewall-rules_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/firewall-rules_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" },
"paused": { "$ref": "#/components/schemas/firewall-rules_components-schemas-paused" },
"priority": { "$ref": "#/components/schemas/firewall-rules_components-schemas-priority" },
@@ -7652,7 +8502,10 @@
{
"properties": {
"filter": {
- "oneOf": [{ "$ref": "#/components/schemas/filter" }, { "$ref": "#/components/schemas/deleted-filter" }]
+ "oneOf": [
+ { "$ref": "#/components/schemas/filter" },
+ { "$ref": "#/components/schemas/deleted-filter" }
+ ]
}
}
}
@@ -7801,7 +8654,15 @@
},
"firewall-rules_components-schemas-action": {
"description": "The action to apply to a matched request. The `log` action is only available on an Enterprise plan.",
- "enum": ["block", "challenge", "js_challenge", "managed_challenge", "allow", "log", "bypass"],
+ "enum": [
+ "block",
+ "challenge",
+ "js_challenge",
+ "managed_challenge",
+ "allow",
+ "log",
+ "bypass"
+ ],
"example": "block",
"type": "string"
},
@@ -7843,7 +8704,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/ua-rules" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/ua-rules" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -7867,13 +8730,20 @@
"example": "scale-down",
"type": "string"
},
- "flag": { "description": "The log retention flag for Logpull API.", "example": true, "type": "boolean" },
+ "flag": {
+ "description": "The log retention flag for Logpull API.",
+ "example": true,
+ "type": "boolean"
+ },
"flag_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "flag": { "example": true, "type": "boolean" } }, "type": "object" }
+ "result": {
+ "properties": { "flag": { "example": true, "type": "boolean" } },
+ "type": "object"
+ }
}
}
]
@@ -7941,7 +8811,11 @@
"gateway-account-device-settings-response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/gateway-account-device-settings" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/gateway-account-device-settings" }
+ }
+ }
],
"type": "object"
},
@@ -7956,7 +8830,10 @@
"description": "Logging settings by rule type.",
"properties": {
"dns": { "description": "Logging settings for DNS firewall.", "type": "object" },
- "http": { "description": "Logging settings for HTTP/HTTPS firewall.", "type": "object" },
+ "http": {
+ "description": "Logging settings for HTTP/HTTPS firewall.",
+ "type": "object"
+ },
"l4": { "description": "Logging settings for Network firewall.", "type": "object" }
},
"type": "object"
@@ -7967,7 +8844,11 @@
"gateway-account-logging-settings-response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/gateway-account-logging-settings" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/gateway-account-logging-settings" }
+ }
+ }
],
"type": "object"
},
@@ -8029,7 +8910,11 @@
],
"type": "object"
},
- "gateway_seat": { "description": "True if the seat is part of Gateway.", "example": false, "type": "boolean" },
+ "gateway_seat": {
+ "description": "True if the seat is part of Gateway.",
+ "example": false,
+ "type": "boolean"
+ },
"gateway_tag": {
"description": "Gateway internal id.",
"example": "f174e90afafe4643bbbc4a0ed4fc8415",
@@ -8068,7 +8953,9 @@
"properties": {
"enabled": { "$ref": "#/components/schemas/script-monitor_components-schemas-enabled" },
"updated_at": { "$ref": "#/components/schemas/schemas-updated_at" },
- "use_cloudflare_reporting_endpoint": { "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint" },
+ "use_cloudflare_reporting_endpoint": {
+ "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint"
+ },
"use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" }
}
},
@@ -8106,7 +8993,11 @@
"example": "ea85612a-29c8-46c2-bacb-669d65136971",
"type": "string"
},
- "name": { "description": "The name of the organization.", "example": "cloudflare", "type": "string" }
+ "name": {
+ "description": "The name of the organization.",
+ "example": "cloudflare",
+ "type": "string"
+ }
},
"required": ["name", "connection_id"],
"type": "object"
@@ -8145,7 +9036,9 @@
"cloudflare_gre_endpoint": { "$ref": "#/components/schemas/cloudflare_gre_endpoint" },
"created_on": { "$ref": "#/components/schemas/common_components-schemas-created_on" },
"customer_gre_endpoint": { "$ref": "#/components/schemas/customer_gre_endpoint" },
- "description": { "$ref": "#/components/schemas/gre-tunnel_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/gre-tunnel_components-schemas-description"
+ },
"health_check": { "$ref": "#/components/schemas/health_check" },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier-2" },
"interface_address": { "$ref": "#/components/schemas/interface_address" },
@@ -8154,7 +9047,12 @@
"name": { "$ref": "#/components/schemas/gre-tunnel_components-schemas-name" },
"ttl": { "$ref": "#/components/schemas/components-schemas-ttl" }
},
- "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"],
+ "required": [
+ "name",
+ "customer_gre_endpoint",
+ "cloudflare_gre_endpoint",
+ "interface_address"
+ ],
"type": "object"
},
"gre-tunnel_components-schemas-description": {
@@ -8209,7 +9107,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/schemas-uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/schemas-uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -8223,7 +9124,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-groups" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-groups" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -8369,7 +9275,9 @@
"consecutive_fails": { "$ref": "#/components/schemas/consecutive_fails" },
"consecutive_successes": { "$ref": "#/components/schemas/consecutive_successes" },
"created_on": { "$ref": "#/components/schemas/timestamp" },
- "description": { "$ref": "#/components/schemas/healthchecks_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-description"
+ },
"failure_reason": { "$ref": "#/components/schemas/failure_reason" },
"http_config": { "$ref": "#/components/schemas/http_config" },
"id": { "$ref": "#/components/schemas/healthchecks_components-schemas-identifier" },
@@ -8396,14 +9304,20 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/healthchecks_components-schemas-identifier" } },
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-identifier"
+ }
+ },
"type": "object"
}
}
}
]
},
- "healthchecks_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "healthchecks_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"healthchecks_components-schemas-name": {
"description": "A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.",
"example": "server-1",
@@ -8412,7 +9326,14 @@
"healthchecks_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/healthchecks" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/healthchecks" },
+ "type": "array"
+ }
+ }
+ }
]
},
"healthchecks_components-schemas-single_response": {
@@ -8434,7 +9355,11 @@
"example": "HTTPS",
"type": "string"
},
- "height": { "description": "The height of the image in pixels.", "readOnly": true, "type": "integer" },
+ "height": {
+ "description": "The height of the image in pixels.",
+ "readOnly": true,
+ "type": "integer"
+ },
"hero_url": {
"description": "URI to hero variant for an image.",
"example": "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero",
@@ -8486,7 +9411,10 @@
"items": { "$ref": "#/components/schemas/history" },
"type": "array"
},
- "result_info": { "example": { "count": 1, "page": 1, "per_page": 20 }, "type": "object" }
+ "result_info": {
+ "example": { "count": 1, "page": 1, "per_page": 20 },
+ "type": "object"
+ }
}
}
]
@@ -8527,9 +9455,13 @@
"certificate": {
"$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"
},
- "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" },
+ "enabled": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"
+ },
"hostname": { "$ref": "#/components/schemas/schemas-hostname" },
- "id": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"
+ },
"private_key": { "$ref": "#/components/schemas/schemas-private_key" }
},
"type": "object"
@@ -8610,7 +9542,9 @@
"cert_id": {
"$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"
},
- "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" },
+ "enabled": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"
+ },
"hostname": { "$ref": "#/components/schemas/schemas-hostname" }
},
"type": "object"
@@ -8629,7 +9563,9 @@
"$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"
},
"created_at": { "$ref": "#/components/schemas/schemas-created_at" },
- "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" },
+ "enabled": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"
+ },
"expires_on": {
"$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"
},
@@ -8637,7 +9573,9 @@
"issuer": { "$ref": "#/components/schemas/issuer" },
"serial_number": { "$ref": "#/components/schemas/serial_number" },
"signature": { "$ref": "#/components/schemas/signature" },
- "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" },
+ "status": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"
+ },
"updated_at": { "$ref": "#/components/schemas/updated_at" }
}
},
@@ -8685,7 +9623,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["http2"], "example": "http2" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["http2"],
+ "example": "http2"
+ },
"value": { "$ref": "#/components/schemas/http2_value" }
}
}
@@ -8704,7 +9646,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["http3"], "example": "http3" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["http3"],
+ "example": "http3"
+ },
"value": { "$ref": "#/components/schemas/http3_value" }
}
}
@@ -8797,7 +9743,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -8826,7 +9774,9 @@
},
"type": "object"
},
- "identity-providers_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "identity-providers_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"identity-providers_components-schemas-name": {
"description": "The name of the identity provider, shown to users on the login page.",
"example": "Widget Corps OTP",
@@ -8837,7 +9787,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/identity-providers" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/identity-providers" },
+ "type": "array"
+ }
}
}
]
@@ -8918,7 +9871,11 @@
"image_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/images" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/images" }, "type": "array" }
+ }
+ }
]
},
"image_response_single": {
@@ -8959,7 +9916,10 @@
},
"type": "object"
},
- "images_stats": { "properties": { "count": { "$ref": "#/components/schemas/images_count" } }, "type": "object" },
+ "images_stats": {
+ "properties": { "count": { "$ref": "#/components/schemas/images_count" } },
+ "type": "object"
+ },
"include": {
"description": "Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.",
"items": { "$ref": "#/components/schemas/rule_components-schemas-rule" },
@@ -8986,7 +9946,9 @@
"properties": {
"colo_name": { "$ref": "#/components/schemas/interconnect_components-schemas-name" },
"created_on": { "$ref": "#/components/schemas/common_components-schemas-created_on" },
- "description": { "$ref": "#/components/schemas/interconnect_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/interconnect_components-schemas-description"
+ },
"gre": { "$ref": "#/components/schemas/gre" },
"health_check": { "$ref": "#/components/schemas/schemas-health_check" },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier-2" },
@@ -9019,7 +9981,11 @@
},
"intune_config_request": {
"properties": {
- "client_id": { "description": "The Intune client ID.", "example": "example client id", "type": "string" },
+ "client_id": {
+ "description": "The Intune client ID.",
+ "example": "example client id",
+ "type": "string"
+ },
"client_secret": {
"description": "The Intune client secret.",
"example": "example client secret",
@@ -9034,7 +10000,10 @@
"required": ["customer_id", "client_id", "client_secret"],
"type": "object"
},
- "invite": { "allOf": [{ "$ref": "#/components/schemas/organization_invite" }], "type": "object" },
+ "invite": {
+ "allOf": [{ "$ref": "#/components/schemas/organization_invite" }],
+ "type": "object"
+ },
"invite_components-schemas-identifier": {
"description": "Invite identifier tag.",
"example": "4f5f0c14a2a41d5063dd301b2f829f04",
@@ -9073,7 +10042,11 @@
"name": { "example": "Malware", "type": "string" }
}
},
- "ip_address": { "description": "An IPv4 or IPv6 address.", "example": "192.0.2.1", "type": "string" },
+ "ip_address": {
+ "description": "An IPv4 or IPv6 address.",
+ "example": "192.0.2.1",
+ "type": "string"
+ },
"ip_components-schemas-ip": {
"properties": {
"belongs_to_ref": {
@@ -9183,7 +10156,12 @@
"title": "IP ranges",
"type": "object"
},
- "ip_version": { "default": "IPv4", "description": "IP version.", "enum": ["IPv4", "IPv6"], "type": "string" },
+ "ip_version": {
+ "default": "IPv4",
+ "description": "IP version.",
+ "enum": ["IPv4", "IPv6"],
+ "type": "string"
+ },
"ipam-delegations": {
"properties": {
"cidr": { "$ref": "#/components/schemas/cidr" },
@@ -9191,7 +10169,9 @@
"delegated_account_id": { "$ref": "#/components/schemas/delegated_account_identifier" },
"id": { "$ref": "#/components/schemas/delegation_identifier" },
"modified_at": { "$ref": "#/components/schemas/timestamp" },
- "parent_prefix_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ "parent_prefix_id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
},
"type": "object"
},
@@ -9213,7 +10193,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/ipam-delegations" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/ipam-delegations" },
+ "type": "array"
+ }
}
}
]
@@ -9233,7 +10216,9 @@
"asn": { "$ref": "#/components/schemas/asn" },
"cidr": { "$ref": "#/components/schemas/cidr" },
"created_at": { "$ref": "#/components/schemas/timestamp" },
- "description": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
"loa_document_id": { "$ref": "#/components/schemas/loa_document_identifier" },
"modified_at": { "$ref": "#/components/schemas/timestamp" },
@@ -9251,7 +10236,14 @@
"ipam-prefixes_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/ipam-prefixes" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/ipam-prefixes" },
+ "type": "array"
+ }
+ }
+ }
]
},
"ipam-prefixes_components-schemas-single_response": {
@@ -9269,7 +10261,11 @@
},
"ipv4_cidrs": {
"description": "List of Cloudflare IPv4 CIDR addresses.",
- "items": { "description": "IPv4 CIDR.", "example": "199.27.128.0/21", "type": "string" },
+ "items": {
+ "description": "IPv4 CIDR.",
+ "example": "199.27.128.0/21",
+ "type": "string"
+ },
"type": "array"
},
"ipv6_cidrs": {
@@ -9286,7 +10282,9 @@
"cloudflare_endpoint": { "$ref": "#/components/schemas/cloudflare_ipsec_endpoint" },
"created_on": { "$ref": "#/components/schemas/common_components-schemas-created_on" },
"customer_endpoint": { "$ref": "#/components/schemas/customer_ipsec_endpoint" },
- "description": { "$ref": "#/components/schemas/ipsec-tunnel_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/ipsec-tunnel_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier-2" },
"interface_address": { "$ref": "#/components/schemas/interface_address" },
"modified_on": { "$ref": "#/components/schemas/common_components-schemas-modified_on" },
@@ -9313,7 +10311,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["ipv6"], "example": "ipv6" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["ipv6"],
+ "example": "ipv6"
+ },
"value": { "$ref": "#/components/schemas/ipv6_value" }
}
}
@@ -9328,7 +10330,11 @@
"enum": ["ip6"],
"example": "ip6"
},
- "value": { "description": "The IPv6 address to match.", "example": "2001:DB8:100::CF", "type": "string" }
+ "value": {
+ "description": "The IPv6 address to match.",
+ "example": "2001:DB8:100::CF",
+ "type": "string"
+ }
},
"title": "An IPv6 address configuration."
},
@@ -9512,7 +10518,9 @@
"key_config": {
"properties": {
"days_until_next_rotation": { "$ref": "#/components/schemas/days_until_next_rotation" },
- "key_rotation_interval_days": { "$ref": "#/components/schemas/key_rotation_interval_days" },
+ "key_rotation_interval_days": {
+ "$ref": "#/components/schemas/key_rotation_interval_days"
+ },
"last_key_rotation_at": { "$ref": "#/components/schemas/last_key_rotation_at" }
},
"type": "object"
@@ -9576,7 +10584,9 @@
},
"enabled": { "$ref": "#/components/schemas/schemas-enabled" },
"host": { "$ref": "#/components/schemas/schemas-host" },
- "id": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier"
+ },
"modified_on": {
"description": "When the Keyless SSL was last modified.",
"example": "2014-01-01T05:20:00Z",
@@ -9595,7 +10605,17 @@
"port": { "$ref": "#/components/schemas/schemas-port" },
"status": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-status" }
},
- "required": ["id", "name", "host", "port", "status", "enabled", "permissions", "created_on", "modified_on"],
+ "required": [
+ "id",
+ "name",
+ "host",
+ "port",
+ "status",
+ "enabled",
+ "permissions",
+ "created_on",
+ "modified_on"
+ ],
"type": "object"
},
"keyless-certificate_components-schemas-identifier": {
@@ -9624,7 +10644,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/keyless-certificate" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/keyless-certificate" },
+ "type": "array"
+ }
}
}
]
@@ -9642,7 +10665,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -9675,7 +10700,10 @@
"type": "string"
},
"keys_components-schemas-single_response": {
- "allOf": [{ "$ref": "#/components/schemas/api-response-single" }, { "$ref": "#/components/schemas/key_config" }]
+ "allOf": [
+ { "$ref": "#/components/schemas/api-response-single" },
+ { "$ref": "#/components/schemas/key_config" }
+ ]
},
"keys_components-schemas-value": {
"description": "Key value.",
@@ -9684,7 +10712,9 @@
"type": "string"
},
"keys_response": {
- "properties": { "keys": { "items": { "$ref": "#/components/schemas/schemas-keys" }, "type": "array" } },
+ "properties": {
+ "keys": { "items": { "$ref": "#/components/schemas/schemas-keys" }, "type": "array" }
+ },
"type": "object"
},
"kind": {
@@ -9732,7 +10762,11 @@
"language_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/captions" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/captions" }, "type": "array" }
+ }
+ }
]
},
"language_response_single": {
@@ -9818,7 +10852,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/item_id" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/item_id" } },
+ "type": "object"
+ }
},
"type": "object"
}
@@ -9866,7 +10903,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-items" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-items" },
+ "type": "array"
+ }
+ }
},
{
"properties": {
@@ -9922,7 +10964,9 @@
{
"properties": {
"result": {
- "properties": { "operation_id": { "$ref": "#/components/schemas/schemas-operation_id" } },
+ "properties": {
+ "operation_id": { "$ref": "#/components/schemas/schemas-operation_id" }
+ },
"type": "object"
}
},
@@ -9939,7 +10983,10 @@
"items": {
"allOf": [
{ "$ref": "#/components/schemas/list" },
- { "required": ["id", "name", "kind", "num_items", "created_on", "modified_on"], "type": "object" }
+ {
+ "required": ["id", "name", "kind", "num_items", "created_on", "modified_on"],
+ "type": "object"
+ }
]
},
"type": "array"
@@ -9987,7 +11034,11 @@
"lists_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/lists" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/lists" }, "type": "array" }
+ }
+ }
]
},
"lists_components-schemas-single_response": {
@@ -10069,7 +11120,9 @@
"properties": {
"allowedOrigins": { "$ref": "#/components/schemas/live_input_recording_allowedOrigins" },
"mode": { "$ref": "#/components/schemas/live_input_recording_mode" },
- "requireSignedURLs": { "$ref": "#/components/schemas/live_input_recording_requireSignedURLs" },
+ "requireSignedURLs": {
+ "$ref": "#/components/schemas/live_input_recording_requireSignedURLs"
+ },
"timeoutSeconds": { "$ref": "#/components/schemas/live_input_recording_timeoutSeconds" }
},
"type": "object"
@@ -10130,7 +11183,11 @@
"properties": {
"result": {
"properties": {
- "filename": { "description": "Name of LOA document.", "example": "document.pdf", "type": "string" }
+ "filename": {
+ "description": "Name of LOA document.",
+ "example": "document.pdf",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -10144,7 +11201,9 @@
"country_pools": { "$ref": "#/components/schemas/country_pools" },
"created_on": { "$ref": "#/components/schemas/timestamp" },
"default_pools": { "$ref": "#/components/schemas/default_pools" },
- "description": { "$ref": "#/components/schemas/load-balancer_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-description"
+ },
"enabled": { "$ref": "#/components/schemas/load-balancer_components-schemas-enabled" },
"fallback_pool": { "$ref": "#/components/schemas/fallback_pool" },
"id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" },
@@ -10157,7 +11216,9 @@
"region_pools": { "$ref": "#/components/schemas/region_pools" },
"rules": { "$ref": "#/components/schemas/load-balancer_components-schemas-rules" },
"session_affinity": { "$ref": "#/components/schemas/session_affinity" },
- "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" },
+ "session_affinity_attributes": {
+ "$ref": "#/components/schemas/session_affinity_attributes"
+ },
"session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" },
"steering_policy": { "$ref": "#/components/schemas/steering_policy" },
"ttl": { "$ref": "#/components/schemas/schemas-ttl" }
@@ -10181,14 +11242,20 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } },
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-identifier"
+ }
+ },
"type": "object"
}
}
}
]
},
- "load-balancer_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "load-balancer_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"load-balancer_components-schemas-name": {
"description": "The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.",
"example": "www.example.com",
@@ -10197,7 +11264,14 @@
"load-balancer_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/load-balancer" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/load-balancer" },
+ "type": "array"
+ }
+ }
+ }
]
},
"load-balancer_components-schemas-rules": {
@@ -10237,7 +11311,10 @@
"maxLength": 1024,
"type": "string"
},
- "status_code": { "description": "The http status code to respond with.", "type": "integer" }
+ "status_code": {
+ "description": "The http status code to respond with.",
+ "type": "integer"
+ }
},
"type": "object"
},
@@ -10259,7 +11336,9 @@
"random_steering": { "$ref": "#/components/schemas/random_steering" },
"region_pools": { "$ref": "#/components/schemas/region_pools" },
"session_affinity": { "$ref": "#/components/schemas/session_affinity" },
- "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" },
+ "session_affinity_attributes": {
+ "$ref": "#/components/schemas/session_affinity_attributes"
+ },
"session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" },
"steering_policy": { "$ref": "#/components/schemas/steering_policy" },
"ttl": { "$ref": "#/components/schemas/schemas-ttl" }
@@ -10374,7 +11453,11 @@
"locations_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/locations" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/locations" }, "type": "array" }
+ }
+ }
]
},
"locations_components-schemas-single_response": {
@@ -10443,7 +11526,11 @@
"example": "https://example.com/logo.png",
"type": "string"
},
- "text_color": { "description": "The text color on your login page.", "example": "#c5ed1b", "type": "string" }
+ "text_color": {
+ "description": "The text color on your login page.",
+ "example": "#c5ed1b",
+ "type": "string"
+ }
}
},
"logo_url": {
@@ -10487,7 +11574,11 @@
"logpush_job_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "items": { "nullable": true, "type": "object" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "nullable": true, "type": "object" }, "type": "array" }
+ }
+ }
]
},
"logpush_job_response_single": {
@@ -10504,7 +11595,11 @@
"description": "The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.",
"type": "number"
},
- "mac_address": { "description": "The device mac address.", "example": "00-00-5E-00-53-00", "type": "string" },
+ "mac_address": {
+ "description": "The device mac address.",
+ "example": "00-00-5E-00-53-00",
+ "type": "string"
+ },
"managed_headers_components-schemas-enabled": {
"description": "When true, the Managed Transform is enabled.",
"example": true,
@@ -10515,7 +11610,11 @@
"example": "add_cf-bot-score_header",
"type": "string"
},
- "manufacturer": { "description": "The device manufacturer name.", "example": "My phone corp", "type": "string" },
+ "manufacturer": {
+ "description": "The device manufacturer name.",
+ "example": "My phone corp",
+ "type": "string"
+ },
"match": {
"description": "Determines which traffic the rate limit counts towards the threshold.",
"oneOf": [
@@ -10541,7 +11640,9 @@
"type": "object"
},
"response": {
- "properties": { "origin_traffic": { "$ref": "#/components/schemas/origin_traffic" } },
+ "properties": {
+ "origin_traffic": { "$ref": "#/components/schemas/origin_traffic" }
+ },
"type": "object"
}
},
@@ -10550,12 +11651,25 @@
],
"type": "object"
},
- "match_item": { "properties": { "platform": { "$ref": "#/components/schemas/platform" } }, "type": "object" },
+ "match_item": {
+ "properties": { "platform": { "$ref": "#/components/schemas/platform" } },
+ "type": "object"
+ },
"matcher": {
"description": "Matching pattern to forward your actions.",
"properties": {
- "field": { "description": "Field for type matcher.", "enum": ["to"], "example": "to", "type": "string" },
- "type": { "description": "Type of matcher.", "enum": ["literal"], "example": "literal", "type": "string" },
+ "field": {
+ "description": "Field for type matcher.",
+ "enum": ["to"],
+ "example": "to",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of matcher.",
+ "enum": ["literal"],
+ "example": "literal",
+ "type": "string"
+ },
"value": {
"description": "Value for matcher.",
"example": "test@example.com",
@@ -10585,7 +11699,13 @@
"max_estimated_time_minutes": { "type": "integer" },
"max_retries": { "example": 3, "type": "number" },
"max_rtt_ms": { "description": "Maximum RTT in ms.", "type": "number" },
- "max_ttl": { "default": 15, "description": "Max TTL.", "maximum": 64, "minimum": 0, "type": "integer" },
+ "max_ttl": {
+ "default": 15,
+ "description": "Max TTL.",
+ "maximum": 64,
+ "minimum": 0,
+ "type": "integer"
+ },
"max_upload": {
"allOf": [
{ "$ref": "#/components/schemas/schemas-base" },
@@ -10632,7 +11752,10 @@
},
"mechanisms": {
"additionalProperties": {
- "items": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" },
+ "items": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ },
"type": "array"
},
"description": "List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.",
@@ -10681,7 +11804,9 @@
"first_name": { "$ref": "#/components/schemas/first_name" },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
"last_name": { "$ref": "#/components/schemas/last_name" },
- "two_factor_authentication_enabled": { "$ref": "#/components/schemas/two_factor_authentication_enabled" }
+ "two_factor_authentication_enabled": {
+ "$ref": "#/components/schemas/two_factor_authentication_enabled"
+ }
},
"readOnly": true,
"required": ["email"],
@@ -10729,7 +11854,10 @@
"messages": {
"example": [],
"items": {
- "properties": { "code": { "minimum": 1000, "type": "integer" }, "message": { "type": "string" } },
+ "properties": {
+ "code": { "minimum": 1000, "type": "integer" },
+ "message": { "type": "string" }
+ },
"required": ["code", "message"],
"type": "object",
"uniqueItems": true
@@ -10788,7 +11916,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "Zone setting identifier.", "enum": ["minify"], "example": "minify" },
+ "id": {
+ "description": "Zone setting identifier.",
+ "enum": ["minify"],
+ "example": "minify"
+ },
"value": { "$ref": "#/components/schemas/minify_value" }
}
}
@@ -10835,7 +11967,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["mirage"], "example": "mirage" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["mirage"],
+ "example": "mirage"
+ },
"value": { "$ref": "#/components/schemas/mirage_value" }
}
}
@@ -10855,8 +11991,14 @@
"content_removes": { "description": "Content category IDs to remove.", "example": [155] },
"indicator_type": { "enum": ["domain", "ipv4", "ipv6", "url"], "example": "domain" },
"ip": { "description": "Provide only if indicator_type is `ipv4` or `ipv6`." },
- "security_adds": { "description": "Security category IDs to add.", "example": [117, 131] },
- "security_removes": { "description": "Security category IDs to remove.", "example": [83] },
+ "security_adds": {
+ "description": "Security category IDs to add.",
+ "example": [117, 131]
+ },
+ "security_removes": {
+ "description": "Security category IDs to remove.",
+ "example": [83]
+ },
"url": {
"description": "Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.",
"type": "string"
@@ -10888,10 +12030,15 @@
"example": "203.0.113.1/32",
"type": "string"
},
- "mnm_config_router_ips": { "items": { "$ref": "#/components/schemas/mnm_config_router_ip" }, "type": "array" },
+ "mnm_config_router_ips": {
+ "items": { "$ref": "#/components/schemas/mnm_config_router_ip" },
+ "type": "array"
+ },
"mnm_rule": {
"properties": {
- "automatic_advertisement": { "$ref": "#/components/schemas/mnm_rule_automatic_advertisement" },
+ "automatic_advertisement": {
+ "$ref": "#/components/schemas/mnm_rule_automatic_advertisement"
+ },
"bandwidth_threshold": { "$ref": "#/components/schemas/mnm_rule_bandwidth_threshold" },
"duration": { "$ref": "#/components/schemas/mnm_rule_duration" },
"id": { "$ref": "#/components/schemas/schemas-rule_identifier" },
@@ -10924,7 +12071,10 @@
"example": "203.0.113.1/32",
"type": "string"
},
- "mnm_rule_ip_prefixes": { "items": { "$ref": "#/components/schemas/mnm_rule_ip_prefix" }, "type": "array" },
+ "mnm_rule_ip_prefixes": {
+ "items": { "$ref": "#/components/schemas/mnm_rule_ip_prefix" },
+ "type": "array"
+ },
"mnm_rule_name": {
"description": "The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.",
"example": "my_rule_1",
@@ -11002,7 +12152,11 @@
"example": "block",
"type": "string"
},
- "model": { "description": "The device model name.", "example": "MyPhone(pro-X)", "type": "string" },
+ "model": {
+ "description": "The device model name.",
+ "example": "MyPhone(pro-X)",
+ "type": "string"
+ },
"modified": {
"description": "The date and time the destination address was last modified.",
"example": "2014-01-02T02:20:00Z",
@@ -11039,7 +12193,10 @@
"result": {
"properties": {
"modified": { "example": true, "type": "boolean" },
- "modified_gre_tunnels": { "items": { "$ref": "#/components/schemas/gre-tunnel" }, "type": "array" }
+ "modified_gre_tunnels": {
+ "items": { "$ref": "#/components/schemas/gre-tunnel" },
+ "type": "array"
+ }
}
}
}
@@ -11048,7 +12205,9 @@
},
"modify_request": {
"properties": {
- "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-description"
+ },
"dnslink": { "$ref": "#/components/schemas/dnslink" }
},
"type": "object"
@@ -11085,7 +12244,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -11101,7 +12262,11 @@
"monitor_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/monitor" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/monitor" }, "type": "array" }
+ }
+ }
]
},
"monitor_components-schemas-response_collection-2": {
@@ -11109,7 +12274,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/components-schemas-monitor" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/components-schemas-monitor" },
+ "type": "array"
+ }
}
}
]
@@ -11123,7 +12291,11 @@
"monitor_components-schemas-single_response-2": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/components-schemas-monitor" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/components-schemas-monitor" }
+ }
+ }
]
},
"monitor_components-schemas-type": {
@@ -11146,14 +12318,22 @@
"result": {
"properties": {
"modified": { "example": true, "type": "boolean" },
- "modified_routes": { "items": { "$ref": "#/components/schemas/schemas-route" }, "type": "array" }
+ "modified_routes": {
+ "items": { "$ref": "#/components/schemas/schemas-route" },
+ "type": "array"
+ }
}
}
}
}
]
},
- "name": { "description": "Token name.", "example": "readonly token", "maxLength": 120, "type": "string" },
+ "name": {
+ "description": "Token name.",
+ "example": "readonly token",
+ "maxLength": 120,
+ "type": "string"
+ },
"name_servers": {
"description": "List of name servers.",
"example": ["preston.ns.cloudflare.com", "oli.ns.cloudflare.com"],
@@ -11204,7 +12384,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "Zone setting identifier.", "enum": ["nel"], "example": "nel" },
+ "id": {
+ "description": "Zone setting identifier.",
+ "enum": ["nel"],
+ "example": "nel"
+ },
"value": { "$ref": "#/components/schemas/nel_value" }
}
}
@@ -11241,8 +12425,16 @@
"new_custom_entry": {
"description": "A custom entry create payload",
"properties": {
- "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" },
- "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" },
+ "enabled": {
+ "description": "Whether the entry is enabled or not.",
+ "example": true,
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The name of the entry.",
+ "example": "Credit card (Visa)",
+ "type": "string"
+ },
"pattern": { "$ref": "#/components/schemas/components-schemas-pattern" }
},
"required": ["name", "enabled", "pattern"],
@@ -11261,7 +12453,11 @@
"items": { "$ref": "#/components/schemas/new_custom_entry" },
"type": "array"
},
- "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" }
+ "name": {
+ "description": "The name of the profile.",
+ "example": "Generic CVV Card Number",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -11298,7 +12494,11 @@
"readOnly": true,
"type": "string"
},
- "token": { "description": "The token ID for the NFT.", "readOnly": true, "type": "integer" }
+ "token": {
+ "description": "The token ID for the NFT.",
+ "readOnly": true,
+ "type": "integer"
+ }
},
"readOnly": true,
"type": "object"
@@ -11365,7 +12565,11 @@
"format": "hostname",
"type": "string"
},
- "num_items": { "description": "The number of items in the list.", "example": 10, "type": "number" },
+ "num_items": {
+ "description": "The number of items in the list.",
+ "example": 10,
+ "type": "number"
+ },
"num_referencing_filters": {
"description": "The number of [filters](#filters) referencing the list.",
"example": 2,
@@ -11453,7 +12657,9 @@
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
- "parameters": [{ "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }]
+ "parameters": [
+ { "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }
+ ]
}
}
},
@@ -11470,7 +12676,9 @@
"... Further paths ...": {},
"/api/v1/users/{var1}": {
"get": {
- "parameters": [{ "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }]
+ "parameters": [
+ { "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }
+ ]
}
}
},
@@ -11579,7 +12787,11 @@
"permissions": { "$ref": "#/components/schemas/schemas-permissions" },
"roles": {
"description": "List of roles that a user has within an organization.",
- "items": { "example": "All Privileges - Super Administrator", "maxLength": 120, "type": "string" },
+ "items": {
+ "example": "All Privileges - Super Administrator",
+ "maxLength": 120,
+ "type": "string"
+ },
"readOnly": true,
"type": "array"
},
@@ -11626,7 +12838,9 @@
},
"type": "object"
},
- "organizations_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "organizations_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"organizations_components-schemas-name": {
"description": "The name of your Zero Trust organization.",
"example": "Widget Corps Internal Applications",
@@ -11750,7 +12964,9 @@
"allOf": [
{ "$ref": "#/components/schemas/origin_max_http_version" },
{
- "properties": { "value": { "$ref": "#/components/schemas/origin_max_http_version_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/origin_max_http_version_value" }
+ },
"required": ["value"]
}
]
@@ -11798,9 +13014,21 @@
"items": { "$ref": "#/components/schemas/schemas-origin" },
"type": "array"
},
- "os_distro_name": { "description": "The Linux distro name.", "example": "ubuntu", "type": "string" },
- "os_distro_revision": { "description": "The Linux distro revision.", "example": "1.0.0", "type": "string" },
- "os_version": { "description": "The operating system version.", "example": "10.0.0", "type": "string" },
+ "os_distro_name": {
+ "description": "The Linux distro name.",
+ "example": "ubuntu",
+ "type": "string"
+ },
+ "os_distro_revision": {
+ "description": "The Linux distro revision.",
+ "example": "1.0.0",
+ "type": "string"
+ },
+ "os_version": {
+ "description": "The operating system version.",
+ "example": "10.0.0",
+ "type": "string"
+ },
"output": {
"properties": {
"enabled": { "$ref": "#/components/schemas/output_enabled" },
@@ -11825,7 +13053,11 @@
"output_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/output" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/output" }, "type": "array" }
+ }
+ }
]
},
"output_response_single": {
@@ -11848,7 +13080,9 @@
},
"override": {
"properties": {
- "description": { "$ref": "#/components/schemas/overrides_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/overrides_components-schemas-description"
+ },
"groups": { "$ref": "#/components/schemas/groups" },
"id": { "$ref": "#/components/schemas/overrides_components-schemas-id" },
"paused": { "$ref": "#/components/schemas/schemas-paused" },
@@ -11864,7 +13098,9 @@
{
"properties": {
"result": {
- "properties": { "disable_for_time": { "$ref": "#/components/schemas/disable_for_time" } },
+ "properties": {
+ "disable_for_time": { "$ref": "#/components/schemas/disable_for_time" }
+ },
"type": "object"
}
}
@@ -12035,7 +13271,11 @@
"package_response_collection": {
"anyOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/package" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/package" }, "type": "array" }
+ }
+ }
]
},
"package_response_single": {
@@ -12044,7 +13284,10 @@
{ "properties": { "result": { "type": "object" } } }
]
},
- "packet_count": { "description": "Number of packets with a response from this node.", "type": "integer" },
+ "packet_count": {
+ "description": "Number of packets with a response from this node.",
+ "type": "integer"
+ },
"packet_type": {
"default": "icmp",
"description": "Type of packet sent.",
@@ -12052,7 +13295,10 @@
"example": "icmp",
"type": "string"
},
- "packets_lost": { "description": "Number of packets where no response was received.", "type": "integer" },
+ "packets_lost": {
+ "description": "Number of packets where no response was received.",
+ "type": "integer"
+ },
"packets_per_ttl": {
"default": 3,
"description": "Number of packets sent at each TTL.",
@@ -12060,7 +13306,10 @@
"minimum": 0,
"type": "integer"
},
- "packets_sent": { "description": "Number of packets sent with specified TTL.", "type": "integer" },
+ "packets_sent": {
+ "description": "Number of packets sent with specified TTL.",
+ "type": "integer"
+ },
"packets_ttl": { "description": "The time to live (TTL).", "type": "integer" },
"padding": {
"default": 0.05,
@@ -12071,13 +13320,19 @@
"readOnly": true,
"type": "number"
},
- "page": { "description": "Current page within paginated list of results.", "example": 1, "type": "number" },
+ "page": {
+ "description": "Current page within paginated list of results.",
+ "example": 1,
+ "type": "number"
+ },
"page-rule": {
"properties": {
"actions": { "$ref": "#/components/schemas/schemas-actions" },
"created_on": { "$ref": "#/components/schemas/created_on" },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
- "modified_on": { "$ref": "#/components/schemas/page-rule_components-schemas-modified_on" },
+ "modified_on": {
+ "$ref": "#/components/schemas/page-rule_components-schemas-modified_on"
+ },
"priority": { "$ref": "#/components/schemas/page-rule_components-schemas-priority" },
"status": { "$ref": "#/components/schemas/page-rule_components-schemas-status" },
"targets": { "$ref": "#/components/schemas/targets" }
@@ -12119,13 +13374,21 @@
"pagerduty_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/pagerduty" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/pagerduty" }, "type": "array" }
+ }
+ }
]
},
"pagerule_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/page-rule" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/page-rule" }, "type": "array" }
+ }
+ }
]
},
"pagerule_response_single": {
@@ -12143,7 +13406,10 @@
"pageviews": {
"description": "Breakdown of totals for pageviews.",
"properties": {
- "all": { "description": "The total number of pageviews served within the time range.", "type": "integer" },
+ "all": {
+ "description": "The total number of pageviews served within the time range.",
+ "type": "integer"
+ },
"search_engine": {
"description": "A variable list of key/value pairs representing the search engine and number of hits.",
"example": { "baidubot": 1345, "bingbot": 5372, "googlebot": 35272, "pingdom": 13435 },
@@ -12159,8 +13425,16 @@
"example": 1,
"type": "number"
},
- "page": { "description": "Current page within paginated list of results.", "example": 1, "type": "number" },
- "per_page": { "description": "Number of results per page of results.", "example": 20, "type": "number" },
+ "page": {
+ "description": "Current page within paginated list of results.",
+ "example": 1,
+ "type": "number"
+ },
+ "per_page": {
+ "description": "Number of results per page of results.",
+ "example": 20,
+ "type": "number"
+ },
"reverse_records": {
"description": "Reverse DNS look-ups observed during the time period.",
"items": {
@@ -12274,14 +13548,26 @@
"example": "1.2.3.4",
"type": "string"
},
- "destination_port": { "description": "The destination port of the packet.", "example": 80, "type": "number" },
- "protocol": { "description": "The protocol number of the packet.", "example": 6, "type": "number" },
+ "destination_port": {
+ "description": "The destination port of the packet.",
+ "example": 80,
+ "type": "number"
+ },
+ "protocol": {
+ "description": "The protocol number of the packet.",
+ "example": 6,
+ "type": "number"
+ },
"source_address": {
"description": "The source IP address of the packet.",
"example": "1.2.3.4",
"type": "string"
},
- "source_port": { "description": "The source port of the packet.", "example": 123, "type": "number" }
+ "source_port": {
+ "description": "The source port of the packet.",
+ "example": 123,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -12312,7 +13598,9 @@
]
},
"pcaps_ownership_request": {
- "properties": { "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" } },
+ "properties": {
+ "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" }
+ },
"required": ["destination_conf"],
"type": "object"
},
@@ -12350,7 +13638,9 @@
"pcaps_ownership_single_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "$ref": "#/components/schemas/pcaps_ownership_response" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/pcaps_ownership_response" } }
+ }
]
},
"pcaps_ownership_validate_request": {
@@ -12506,7 +13796,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/peer_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/peer_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -12522,7 +13814,11 @@
"peer_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/peer" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/peer" }, "type": "array" }
+ }
+ }
]
},
"peer_components-schemas-single_response": {
@@ -12543,7 +13839,11 @@
"readOnly": true,
"type": "string"
},
- "per_page": { "description": "Number of results per page of results.", "example": 20, "type": "number" },
+ "per_page": {
+ "description": "Number of results per page of results.",
+ "example": 20,
+ "type": "number"
+ },
"period": {
"description": "The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.",
"example": 900,
@@ -12585,7 +13885,10 @@
"type": "array"
},
"permissions": {
- "example": { "analytics": { "read": true, "write": false }, "zones": { "read": true, "write": true } },
+ "example": {
+ "analytics": { "read": true, "write": false },
+ "zones": { "read": true, "write": true }
+ },
"properties": {
"analytics": { "$ref": "#/components/schemas/grants" },
"billing": { "$ref": "#/components/schemas/grants" },
@@ -12625,8 +13928,16 @@
"example": 0.99,
"type": "number"
},
- "url": { "description": "URL that was scanned.", "example": "https://www.cloudflare.com", "type": "string" },
- "verified": { "description": "Whether the URL has been hand verified.", "example": false, "type": "boolean" }
+ "url": {
+ "description": "URL that was scanned.",
+ "example": "https://www.cloudflare.com",
+ "type": "string"
+ },
+ "verified": {
+ "description": "Whether the URL has been hand verified.",
+ "example": false,
+ "type": "boolean"
+ }
}
},
"phishing_components-schemas-single_response": {
@@ -12640,13 +13951,20 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-rate-plan" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-rate-plan" },
+ "type": "array"
+ }
},
"type": "object"
}
]
},
- "platform": { "enum": ["windows", "mac", "linux", "android", "ios"], "example": "windows", "type": "string" },
+ "platform": {
+ "enum": ["windows", "mac", "linux", "android", "ios"],
+ "example": "windows",
+ "type": "string"
+ },
"playback": {
"properties": {
"dash": {
@@ -12699,7 +14017,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -12720,7 +14041,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-policies" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-policies" },
+ "type": "array"
+ }
}
}
]
@@ -12730,7 +14054,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/components-schemas-policies" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/components-schemas-policies" },
+ "type": "array"
+ }
}
}
]
@@ -12744,7 +14071,11 @@
"policies_components-schemas-single_response-2": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/components-schemas-policies" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/components-schemas-policies" }
+ }
+ }
]
},
"policy": {
@@ -12788,10 +14119,16 @@
},
"user_identity": {
"properties": {
- "account_id": { "example": "41ecfbb341f033e52b46742756aabb8b", "type": "string" },
+ "account_id": {
+ "example": "41ecfbb341f033e52b46742756aabb8b",
+ "type": "string"
+ },
"device_sessions": { "example": {}, "type": "object" },
"email": { "example": "testuser@gmail.com", "type": "string" },
- "geo": { "properties": { "country": { "example": "US", "type": "string" } }, "type": "object" },
+ "geo": {
+ "properties": { "country": { "example": "US", "type": "string" } },
+ "type": "object"
+ },
"iat": { "type": "integer" },
"id": { "example": "1164449231815010287495", "type": "string" },
"is_gateway": { "example": false, "type": "boolean" },
@@ -12824,7 +14161,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["polish"], "example": "polish" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["polish"],
+ "example": "polish"
+ },
"value": { "$ref": "#/components/schemas/polish_value" }
}
}
@@ -12877,7 +14218,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/pool_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/pool_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -12893,7 +14236,11 @@
"pool_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/pool" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/pool" }, "type": "array" }
+ }
+ }
]
},
"pool_components-schemas-single_response": {
@@ -12934,9 +14281,17 @@
"predefined_entry": {
"description": "A predefined entry that matches a profile",
"properties": {
- "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" },
+ "enabled": {
+ "description": "Whether the entry is enabled or not.",
+ "example": true,
+ "type": "boolean"
+ },
"id": { "$ref": "#/components/schemas/entry_id" },
- "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" },
+ "name": {
+ "description": "The name of the entry.",
+ "example": "Credit card (Visa)",
+ "type": "string"
+ },
"profile_id": { "description": "ID of the parent profile" }
},
"title": "Predefined entry",
@@ -12950,7 +14305,11 @@
"type": "array"
},
"id": { "$ref": "#/components/schemas/profile_id" },
- "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" },
+ "name": {
+ "description": "The name of the profile.",
+ "example": "Generic CVV Card Number",
+ "type": "string"
+ },
"type": {
"description": "The type of the profile.",
"enum": ["predefined"],
@@ -12964,7 +14323,11 @@
"predefined_profile_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "allOf": [{ "$ref": "#/components/schemas/predefined_profile" }] } } }
+ {
+ "properties": {
+ "result": { "allOf": [{ "$ref": "#/components/schemas/predefined_profile" }] }
+ }
+ }
]
},
"prefetch_preload": {
@@ -13020,7 +14383,9 @@
"type": "object",
"x-patternProperties": { "^[a-z0-9]{32}$": { "type": "string" } }
},
- "preview_id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" }
+ "preview_id": {
+ "$ref": "#/components/schemas/monitor_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -13034,7 +14399,13 @@
"example": {
"abwlnp5jbqn45ecgxd03erbgtxtqai0d": {
"healthy": true,
- "origins": [{ "originone.example.com.": { "$ref": "#/components/schemas/origin_health_data/example" } }]
+ "origins": [
+ {
+ "originone.example.com.": {
+ "$ref": "#/components/schemas/origin_health_data/example"
+ }
+ }
+ ]
}
},
"type": "object"
@@ -13073,7 +14444,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["privacy_pass"], "example": "privacy_pass" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["privacy_pass"],
+ "example": "privacy_pass"
+ },
"value": { "$ref": "#/components/schemas/privacy_pass_value" }
}
}
@@ -13120,7 +14495,11 @@
"profiles_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/profiles" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/profiles" }, "type": "array" }
+ }
+ }
]
},
"project-patch": {
@@ -13180,7 +14559,11 @@
"oneOf": [{ "nullable": true }, { "$ref": "#/components/schemas/deployments" }],
"readOnly": true
},
- "name": { "description": "Name of the project.", "example": "NextJS Blog", "type": "string" },
+ "name": {
+ "description": "Name of the project.",
+ "example": "NextJS Blog",
+ "type": "string"
+ },
"production_branch": {
"description": "Production branch of the project. Used to identify production deployments.",
"example": "main",
@@ -13263,7 +14646,9 @@
{ "properties": { "result": { "type": "object" } } }
]
},
- "proxy-endpoints_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" },
+ "proxy-endpoints_components-schemas-identifier": {
+ "example": "699d98642c564d2e855e9661899b7252"
+ },
"proxy-endpoints_components-schemas-name": {
"description": "The name of the Proxy Endpoint.",
"example": "Devops team",
@@ -13273,7 +14658,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/proxy-endpoints" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/proxy-endpoints" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -13348,7 +14738,9 @@
"properties": {
"result": {
"properties": {
- "ipsec_tunnel_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
+ "ipsec_tunnel_id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ },
"psk": { "$ref": "#/components/schemas/psk" },
"psk_metadata": { "$ref": "#/components/schemas/psk_metadata" }
}
@@ -13359,7 +14751,11 @@
},
"psk_metadata": {
"description": "The PSK metadata that includes when the PSK was generated.",
- "properties": { "last_generated_on": { "$ref": "#/components/schemas/common_components-schemas-modified_on" } },
+ "properties": {
+ "last_generated_on": {
+ "$ref": "#/components/schemas/common_components-schemas-modified_on"
+ }
+ },
"type": "object"
},
"public_key": {
@@ -13418,7 +14814,11 @@
"description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .",
"type": "string"
},
- "limit": { "default": 10000, "description": "Limit number of returned metrics.", "type": "integer" },
+ "limit": {
+ "default": 10000,
+ "description": "Limit number of returned metrics.",
+ "type": "integer"
+ },
"metrics": {
"description": "One or more metrics to compute.",
"items": { "description": "A quantitative measurement of KV usage.", "type": "string" },
@@ -13451,7 +14851,9 @@
"properties": {
"custom_page_html": { "$ref": "#/components/schemas/event_custom_page_html" },
"description": { "$ref": "#/components/schemas/event_description" },
- "disable_session_renewal": { "$ref": "#/components/schemas/event_disable_session_renewal" },
+ "disable_session_renewal": {
+ "$ref": "#/components/schemas/event_disable_session_renewal"
+ },
"event_end_time": { "$ref": "#/components/schemas/event_end_time" },
"event_start_time": { "$ref": "#/components/schemas/event_start_time" },
"name": { "$ref": "#/components/schemas/event_name" },
@@ -13472,7 +14874,9 @@
"check_regions": { "$ref": "#/components/schemas/schemas-check_regions" },
"consecutive_fails": { "$ref": "#/components/schemas/consecutive_fails" },
"consecutive_successes": { "$ref": "#/components/schemas/consecutive_successes" },
- "description": { "$ref": "#/components/schemas/healthchecks_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-description"
+ },
"http_config": { "$ref": "#/components/schemas/http_config" },
"interval": { "$ref": "#/components/schemas/components-schemas-interval" },
"name": { "$ref": "#/components/schemas/healthchecks_components-schemas-name" },
@@ -13508,7 +14912,9 @@
"cookie_attributes": { "$ref": "#/components/schemas/cookie_attributes" },
"custom_page_html": { "$ref": "#/components/schemas/custom_page_html" },
"default_template_language": { "$ref": "#/components/schemas/default_template_language" },
- "description": { "$ref": "#/components/schemas/waitingroom_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-description"
+ },
"disable_session_renewal": { "$ref": "#/components/schemas/disable_session_renewal" },
"host": { "$ref": "#/components/schemas/components-schemas-host" },
"json_response_enabled": { "$ref": "#/components/schemas/json_response_enabled" },
@@ -13670,7 +15076,11 @@
"railgun_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/railgun" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/railgun" }, "type": "array" }
+ }
+ }
]
},
"railgun_response_single": {
@@ -13685,7 +15095,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" }
+ }
}
}
}
@@ -13705,13 +15117,19 @@
},
"pool_weights": {
"description": "A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.",
- "example": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 },
+ "example": {
+ "9290f38c5d07c2e2f4df57b1f61d4196": 0.5,
+ "de90f38ced07c2e2f4df50b1f61d4194": 0.3
+ },
"type": "object"
}
},
"type": "object"
},
- "rate-limits": { "allOf": [{ "$ref": "#/components/schemas/components-schemas-ratelimit" }], "type": "object" },
+ "rate-limits": {
+ "allOf": [{ "$ref": "#/components/schemas/components-schemas-ratelimit" }],
+ "type": "object"
+ },
"rate-limits_components-schemas-id": {
"description": "The unique identifier of the rate limit.",
"example": "372e67954025e0ba6aaa6d586b9e0b59",
@@ -13767,7 +15185,11 @@
"example": "Business Plan",
"type": "string"
},
- "scope": { "description": "The scope that this rate plan applies to.", "example": "zone", "type": "string" },
+ "scope": {
+ "description": "The scope that this rate plan applies to.",
+ "example": "zone",
+ "type": "string"
+ },
"sets": {
"description": "The list of sets this rate plan applies to.",
"items": { "type": "string" },
@@ -13788,7 +15210,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/rate-limits" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/rate-limits" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -13861,7 +15285,21 @@
},
"region_code": {
"description": "A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).",
- "enum": ["WNAM", "ENAM", "WEU", "EEU", "NSAM", "SSAM", "OC", "ME", "NAF", "SAF", "SAS", "SEAS", "NEAS"],
+ "enum": [
+ "WNAM",
+ "ENAM",
+ "WEU",
+ "EEU",
+ "NSAM",
+ "SSAM",
+ "OC",
+ "ME",
+ "NAF",
+ "SAF",
+ "SAS",
+ "SEAS",
+ "NEAS"
+ ],
"example": "WNAM",
"type": "string"
},
@@ -13956,7 +15394,10 @@
},
"type": "object"
},
- "request_list": { "items": { "$ref": "#/components/schemas/request_model" }, "type": "array" },
+ "request_list": {
+ "items": { "$ref": "#/components/schemas/request_model" },
+ "type": "array"
+ },
"request_model": {
"properties": {
"enabled": { "$ref": "#/components/schemas/managed_headers_components-schemas-enabled" },
@@ -13998,7 +15439,10 @@
"example": { "200": 13496983, "301": 283, "400": 187936, "402": 1828, "404": 1293 },
"type": "object"
},
- "uncached": { "description": "Total number of requests served from the origin.", "type": "integer" }
+ "uncached": {
+ "description": "Total number of requests served from the origin.",
+ "type": "integer"
+ }
},
"type": "object"
},
@@ -14017,7 +15461,11 @@
"resolves_to_ref": {
"properties": {
"id": { "$ref": "#/components/schemas/stix_identifier" },
- "value": { "description": "IP address or domain name.", "example": "192.0.2.0", "type": "string" }
+ "value": {
+ "description": "IP address or domain name.",
+ "example": "192.0.2.0",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -14050,7 +15498,10 @@
"resource_type": "monitor"
}
],
- "items": { "description": "A reference to a load balancer resource.", "type": "object" },
+ "items": {
+ "description": "A reference to a load balancer resource.",
+ "type": "object"
+ },
"type": "array"
},
"resource_id": { "example": "17b5962d775c646f3f9725cbc7a53df4" },
@@ -14080,7 +15531,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/domain-history" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/domain-history" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -14111,7 +15567,10 @@
"response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }
+ {
+ "properties": { "result": { "items": { "type": "object" }, "type": "array" } },
+ "type": "object"
+ }
]
},
"response_create": {
@@ -14122,7 +15581,10 @@
"result": {
"allOf": [
{ "type": "object" },
- { "properties": { "value": { "$ref": "#/components/schemas/value" } }, "type": "object" }
+ {
+ "properties": { "value": { "$ref": "#/components/schemas/value" } },
+ "type": "object"
+ }
]
}
},
@@ -14130,7 +15592,10 @@
}
]
},
- "response_list": { "items": { "$ref": "#/components/schemas/response_model" }, "type": "array" },
+ "response_list": {
+ "items": { "$ref": "#/components/schemas/response_model" },
+ "type": "array"
+ },
"response_model": {
"properties": {
"available": { "$ref": "#/components/schemas/available" },
@@ -14241,8 +15706,16 @@
"example": 1,
"type": "number"
},
- "page": { "description": "Current page within paginated list of results", "example": 1, "type": "number" },
- "per_page": { "description": "Number of results per page of results", "example": 20, "type": "number" },
+ "page": {
+ "description": "Current page within paginated list of results",
+ "example": 1,
+ "type": "number"
+ },
+ "per_page": {
+ "description": "Number of results per page of results",
+ "example": 20,
+ "type": "number"
+ },
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
@@ -14295,7 +15768,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["rocket_loader"], "example": "rocket_loader" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["rocket_loader"],
+ "example": "rocket_loader"
+ },
"value": { "$ref": "#/components/schemas/rocket_loader_value" }
}
}
@@ -14352,7 +15829,11 @@
"readOnly": true,
"type": "string"
},
- "name": { "description": "The type of route.", "enum": ["forward_url"], "example": "forward_url" },
+ "name": {
+ "description": "The type of route.",
+ "enum": ["forward_url"],
+ "example": "forward_url"
+ },
"value": {
"properties": {
"type": {
@@ -14380,7 +15861,11 @@
"route-response-collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/routes" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/routes" }, "type": "array" }
+ }
+ }
]
},
"route-response-single": {
@@ -14427,7 +15912,10 @@
"readOnly": true,
"type": "string"
},
- "route_components-schemas-priority": { "description": "Priority of the static route.", "type": "integer" },
+ "route_components-schemas-priority": {
+ "description": "Priority of the static route.",
+ "type": "integer"
+ },
"route_deleted_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
@@ -14462,7 +15950,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/teamnet" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/teamnet" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -14481,16 +15971,23 @@
},
"route_update_many_request": {
"properties": {
- "routes": { "items": { "$ref": "#/components/schemas/route_update_single_request" }, "type": "array" }
+ "routes": {
+ "items": { "$ref": "#/components/schemas/route_update_single_request" },
+ "type": "array"
+ }
},
"required": ["routes"],
"type": "object"
},
- "route_update_request": { "allOf": [{ "$ref": "#/components/schemas/route_add_single_request" }] },
+ "route_update_request": {
+ "allOf": [{ "$ref": "#/components/schemas/route_add_single_request" }]
+ },
"route_update_single_request": {
"allOf": [
{
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"required": ["id"]
},
{ "$ref": "#/components/schemas/route_add_single_request" }
@@ -14512,7 +16009,10 @@
"properties": {
"result": {
"properties": {
- "routes": { "items": { "$ref": "#/components/schemas/schemas-route" }, "type": "array" }
+ "routes": {
+ "items": { "$ref": "#/components/schemas/schemas-route" },
+ "type": "array"
+ }
}
}
}
@@ -14555,7 +16055,10 @@
"properties": {
"add_headers": {
"description": "Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s).",
- "example": { "My-Next-Header": ["foo", "bar"], "X-Custom-Header-Name": ["somecustomvalue"] },
+ "example": {
+ "My-Next-Header": ["foo", "bar"],
+ "X-Custom-Header-Name": ["somecustomvalue"]
+ },
"type": "object"
},
"biso_admin_controls": {
@@ -14563,13 +16066,21 @@
"properties": {
"dcp": { "description": "Disable copy-paste.", "example": false, "type": "boolean" },
"dd": { "description": "Disable download.", "example": false, "type": "boolean" },
- "dk": { "description": "Disable keyboard usage.", "example": false, "type": "boolean" },
+ "dk": {
+ "description": "Disable keyboard usage.",
+ "example": false,
+ "type": "boolean"
+ },
"dp": { "description": "Disable printing.", "example": false, "type": "boolean" },
"du": { "description": "Disable upload.", "example": false, "type": "boolean" }
},
"type": "object"
},
- "block_page_enabled": { "description": "Enable the custom block page.", "example": true, "type": "boolean" },
+ "block_page_enabled": {
+ "description": "Enable the custom block page.",
+ "example": true,
+ "type": "boolean"
+ },
"block_reason": {
"description": "The text describing why this block occurred that will be displayed on the custom block page (if enabled).",
"example": "This website is a security risk",
@@ -14604,8 +16115,15 @@
"l4override": {
"description": "Send matching traffic to the supplied destination IP address and port.",
"properties": {
- "ip": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" },
- "port": { "description": "A port number to use for TCP/UDP overrides.", "type": "integer" }
+ "ip": {
+ "description": "IPv4 or IPv6 address.",
+ "example": "1.1.1.1",
+ "type": "string"
+ },
+ "port": {
+ "description": "A port number to use for TCP/UDP overrides.",
+ "type": "integer"
+ }
},
"type": "object"
},
@@ -14617,7 +16135,11 @@
"override_ips": {
"description": "Override matching DNS queries with this.",
"example": ["1.1.1.1", "2.2.2.2"],
- "items": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" },
+ "items": {
+ "description": "IPv4 or IPv6 address.",
+ "example": "1.1.1.1",
+ "type": "string"
+ },
"type": "array"
}
},
@@ -14632,7 +16154,11 @@
"rule_collection_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/rule" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/rule" }, "type": "array" }
+ }
+ }
]
},
"rule_components-schemas-base": {
@@ -14652,7 +16178,9 @@
"priority": { "$ref": "#/components/schemas/rule_components-schemas-priority" }
}
},
- "rule_components-schemas-base-2": { "allOf": [{ "$ref": "#/components/schemas/rule_components-schemas-base" }] },
+ "rule_components-schemas-base-2": {
+ "allOf": [{ "$ref": "#/components/schemas/rule_components-schemas-base" }]
+ },
"rule_components-schemas-description": {
"description": "The public description of the WAF rule.",
"example": "SQL injection prevention for SELECT statements",
@@ -14715,7 +16243,14 @@
"rule_group_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-group" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-group" },
+ "type": "array"
+ }
+ }
+ }
]
},
"rule_group_response_single": {
@@ -14787,7 +16322,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/components-schemas-rule" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/components-schemas-rule" },
+ "type": "array"
+ }
}
}
]
@@ -14816,7 +16354,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/rule_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -14829,9 +16369,15 @@
{ "properties": { "result": { "$ref": "#/components/schemas/rule" } } }
]
},
- "rule_version": { "description": "The version of the rule.", "example": "1", "type": "string" },
+ "rule_version": {
+ "description": "The version of the rule.",
+ "example": "1",
+ "type": "string"
+ },
"rules": { "allOf": [{ "$ref": "#/components/schemas/rule_properties" }], "type": "object" },
- "rules_components-schemas-account_identifier": { "example": "6f91088a406011ed95aed352566e8d4c" },
+ "rules_components-schemas-account_identifier": {
+ "example": "6f91088a406011ed95aed352566e8d4c"
+ },
"rules_components-schemas-action": {
"description": "The action to perform when the rule matches.",
"example": "execute",
@@ -14914,7 +16460,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/rules_components-schemas-rules" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/rules_components-schemas-rules" },
+ "type": "array"
+ }
}
}
]
@@ -14958,7 +16507,11 @@
"rules_components-schemas-single_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/rules_components-schemas-rules" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/rules_components-schemas-rules" }
+ }
+ }
]
},
"rules_components-schemas-uuid": {
@@ -15010,7 +16563,10 @@
"ruleset_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "$ref": "#/components/schemas/ruleset" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/ruleset" } },
+ "type": "object"
+ }
]
},
"ruleset_without_rules": {
@@ -15074,7 +16630,11 @@
"created_at": { "$ref": "#/components/schemas/timestamp" },
"custom_attributes": {
"properties": {
- "name": { "description": "The name of the attribute.", "example": "family_name", "type": "string" },
+ "name": {
+ "description": "The name of the attribute.",
+ "example": "family_name",
+ "type": "string"
+ },
"name_format": {
"description": "A globally unique name for an identity or service provider.",
"enum": [
@@ -15087,7 +16647,11 @@
},
"source": {
"properties": {
- "name": { "description": "The name of the IdP attribute.", "example": "last_name", "type": "string" }
+ "name": {
+ "description": "The name of the IdP attribute.",
+ "example": "last_name",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -15187,7 +16751,10 @@
"properties": {
"result": {
"properties": {
- "schemas": { "items": { "$ref": "#/components/schemas/openapi" }, "type": "array" },
+ "schemas": {
+ "items": { "$ref": "#/components/schemas/openapi" },
+ "type": "array"
+ },
"timestamp": { "type": "string" }
},
"type": "object"
@@ -15203,7 +16770,10 @@
"properties": {
"result": {
"properties": {
- "schemas": { "items": { "$ref": "#/components/schemas/openapiwiththresholds" }, "type": "array" },
+ "schemas": {
+ "items": { "$ref": "#/components/schemas/openapiwiththresholds" },
+ "type": "array"
+ },
"timestamp": { "type": "string" }
},
"type": "object"
@@ -15217,7 +16787,10 @@
"example": false,
"type": "boolean"
},
- "schemas-account": { "allOf": [{ "$ref": "#/components/schemas/account" }], "readOnly": true },
+ "schemas-account": {
+ "allOf": [{ "$ref": "#/components/schemas/account" }],
+ "readOnly": true
+ },
"schemas-account_identifier": { "example": "01a7362d577a6c3019a474fd6f485823" },
"schemas-action": {
"description": "Actions pattern.",
@@ -15280,7 +16853,10 @@
},
"schemas-application": {
"description": "Application that the hostname belongs to.",
- "properties": { "id": { "type": "integer" }, "name": { "example": "CLOUDFLARE", "type": "string" } },
+ "properties": {
+ "id": { "type": "integer" },
+ "name": { "example": "CLOUDFLARE", "type": "string" }
+ },
"type": "object"
},
"schemas-apps": {
@@ -15352,7 +16928,10 @@
],
"type": "object"
},
- "schemas-asn": { "description": "AS number associated with the node object.", "type": "string" },
+ "schemas-asn": {
+ "description": "AS number associated with the node object.",
+ "type": "string"
+ },
"schemas-aud": {
"description": "Audience tag.",
"example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893",
@@ -15391,7 +16970,11 @@
"readOnly": true,
"type": "boolean"
},
- "id": { "description": "Identifier of the zone setting.", "example": "development_mode", "type": "string" },
+ "id": {
+ "description": "Identifier of the zone setting.",
+ "example": "development_mode",
+ "type": "string"
+ },
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
@@ -15416,10 +16999,17 @@
"schemas-bookmark_props": {
"properties": {
"app_launcher_visible": { "default": true },
- "domain": { "description": "The URL or domain of the bookmark.", "example": "https://mybookmark.com" },
+ "domain": {
+ "description": "The URL or domain of the bookmark.",
+ "example": "https://mybookmark.com"
+ },
"logo_url": { "$ref": "#/components/schemas/logo_url" },
"name": { "$ref": "#/components/schemas/apps_components-schemas-name" },
- "type": { "description": "The application type.", "example": "bookmark", "type": "string" }
+ "type": {
+ "description": "The application type.",
+ "example": "bookmark",
+ "type": "string"
+ }
},
"title": "Bookmark Application",
"type": "object"
@@ -15433,7 +17023,9 @@
"properties": {
"beta": { "$ref": "#/components/schemas/beta" },
"class": { "$ref": "#/components/schemas/class" },
- "description": { "$ref": "#/components/schemas/categories_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/categories_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/categories_components-schemas-id" },
"name": { "$ref": "#/components/schemas/categories_components-schemas-name" },
"subcategories": {
@@ -15458,11 +17050,15 @@
"expires_on": {
"$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"
},
- "id": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"
+ },
"issuer": { "$ref": "#/components/schemas/issuer" },
"serial_number": { "$ref": "#/components/schemas/serial_number" },
"signature": { "$ref": "#/components/schemas/signature" },
- "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" },
+ "status": {
+ "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"
+ },
"uploaded_on": { "$ref": "#/components/schemas/components-schemas-uploaded_on" }
}
},
@@ -15476,7 +17072,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/certificates" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/certificates" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -15544,7 +17145,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-invite" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-invite" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -15557,7 +17163,9 @@
"result": {
"items": {
"properties": {
- "additional_information": { "$ref": "#/components/schemas/additional_information" },
+ "additional_information": {
+ "$ref": "#/components/schemas/additional_information"
+ },
"application": { "$ref": "#/components/schemas/schemas-application" },
"content_categories": { "$ref": "#/components/schemas/content_categories" },
"domain": { "$ref": "#/components/schemas/components-schemas-domain_name" },
@@ -15572,7 +17180,11 @@
}
]
},
- "schemas-colo_name": { "description": "Scope colo name.", "example": "den01", "type": "string" },
+ "schemas-colo_name": {
+ "description": "Scope colo name.",
+ "example": "den01",
+ "type": "string"
+ },
"schemas-comment": {
"description": "Optional remark describing the virtual network. Empty if none.",
"example": "Staging VPC for data science",
@@ -15603,7 +17215,9 @@
"created_on": { "$ref": "#/components/schemas/connection_components-schemas-created_on" },
"enabled": { "$ref": "#/components/schemas/connection_components-schemas-enabled" },
"id": { "$ref": "#/components/schemas/connection_components-schemas-identifier" },
- "modified_on": { "$ref": "#/components/schemas/connection_components-schemas-modified_on" },
+ "modified_on": {
+ "$ref": "#/components/schemas/connection_components-schemas-modified_on"
+ },
"zone": { "$ref": "#/components/schemas/connection_components-schemas-zone" }
},
"required": ["id", "zone", "enabled"],
@@ -15618,7 +17232,9 @@
"properties": {
"account": {
"description": "Account in which the zone was created.",
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"type": "object"
},
"name": { "$ref": "#/components/schemas/properties-name" },
@@ -15658,7 +17274,11 @@
"example": false,
"type": "boolean"
},
- "schemas-deleted": { "description": "True if the device was deleted.", "example": true, "type": "boolean" },
+ "schemas-deleted": {
+ "description": "True if the device was deleted.",
+ "example": true,
+ "type": "boolean"
+ },
"schemas-deleted_at": {
"description": "If present, indicates tunnel was deleted at the given date (formatted in RFC 3339). If absent, tunnel has not been deleted.",
"example": "2009-11-10T23:00:00Z",
@@ -15715,11 +17335,18 @@
"readOnly": true,
"type": "string"
},
- "schemas-dns-firewall": { "allOf": [{ "$ref": "#/components/schemas/dns-firewall" }], "type": "object" },
+ "schemas-dns-firewall": {
+ "allOf": [{ "$ref": "#/components/schemas/dns-firewall" }],
+ "type": "object"
+ },
"schemas-dns-record": {
"description": "List of records needed to enable an Email Routing zone.",
"properties": {
- "content": { "description": "DNS record content.", "example": "127.0.0.1", "type": "string" },
+ "content": {
+ "description": "DNS record content.",
+ "example": "127.0.0.1",
+ "type": "string"
+ },
"name": {
"description": "DNS record name (or @ for the zone apex).",
"example": "example.com",
@@ -15780,7 +17407,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/domain" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/domain" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -15788,7 +17417,10 @@
"schemas-domain-response-single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "$ref": "#/components/schemas/domain" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/domain" } },
+ "type": "object"
+ }
]
},
"schemas-domain_identifier": {
@@ -15798,7 +17430,11 @@
"readOnly": true,
"type": "string"
},
- "schemas-domain_name": { "description": "Domain name.", "example": "cloudflare.com", "type": "string" },
+ "schemas-domain_name": {
+ "description": "Domain name.",
+ "example": "cloudflare.com",
+ "type": "string"
+ },
"schemas-duration": {
"description": "The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.",
"readOnly": true,
@@ -16033,7 +17669,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -16042,10 +17680,15 @@
]
},
"schemas-identifier": {},
- "schemas-include": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" },
+ "schemas-include": {
+ "items": { "$ref": "#/components/schemas/split_tunnel_include" },
+ "type": "array"
+ },
"schemas-input": {
"description": "The value to be checked against.",
- "properties": { "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" }
+ },
"type": "object"
},
"schemas-interval": {
@@ -16053,8 +17696,15 @@
"example": "10m",
"type": "string"
},
- "schemas-invite": { "allOf": [{ "$ref": "#/components/schemas/user_invite" }], "type": "object" },
- "schemas-ip": { "description": "An IPv4 or IPv6 address.", "example": "192.0.2.1", "type": "string" },
+ "schemas-invite": {
+ "allOf": [{ "$ref": "#/components/schemas/user_invite" }],
+ "type": "object"
+ },
+ "schemas-ip": {
+ "description": "An IPv4 or IPv6 address.",
+ "example": "192.0.2.1",
+ "type": "string"
+ },
"schemas-ip_configuration": {
"properties": {
"target": {
@@ -16298,7 +17948,9 @@
"paused": { "$ref": "#/components/schemas/paused" },
"plan": {
"description": "The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.",
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"type": "object"
},
"type": {
@@ -16317,7 +17969,11 @@
"example": "/shop/checkout",
"type": "string"
},
- "schemas-pattern": { "example": "example.net/*", "title": "Filter pattern", "type": "string" },
+ "schemas-pattern": {
+ "example": "example.net/*",
+ "title": "Filter pattern",
+ "type": "string"
+ },
"schemas-paused": {
"description": "When true, indicates that the WAF package is currently paused.",
"type": "boolean"
@@ -16330,7 +17986,11 @@
},
"schemas-phase": {
"description": "The phase where the ruleset is executed.",
- "enum": ["http_request_transform", "http_request_late_transform", "http_response_headers_transform"],
+ "enum": [
+ "http_request_transform",
+ "http_request_late_transform",
+ "http_response_headers_transform"
+ ],
"type": "string"
},
"schemas-policies": {
@@ -16344,8 +18004,12 @@
"include": { "$ref": "#/components/schemas/include" },
"name": { "$ref": "#/components/schemas/policies_components-schemas-name" },
"precedence": { "$ref": "#/components/schemas/precedence" },
- "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" },
- "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" },
+ "purpose_justification_prompt": {
+ "$ref": "#/components/schemas/purpose_justification_prompt"
+ },
+ "purpose_justification_required": {
+ "$ref": "#/components/schemas/purpose_justification_required"
+ },
"require": { "$ref": "#/components/schemas/schemas-require" },
"updated_at": { "$ref": "#/components/schemas/timestamp" }
},
@@ -16439,7 +18103,10 @@
{ "properties": { "result": { "items": { "type": "object" }, "type": "array" } } }
]
},
- "schemas-rate-plan": { "allOf": [{ "$ref": "#/components/schemas/rate-plan" }], "type": "object" },
+ "schemas-rate-plan": {
+ "allOf": [{ "$ref": "#/components/schemas/rate-plan" }],
+ "type": "object"
+ },
"schemas-ratelimit": {
"description": "Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).\nNotes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100.",
"example": 600,
@@ -16502,7 +18169,13 @@
"cached": { "description": "Total number of cached requests served.", "type": "integer" },
"content_type": {
"description": "A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.",
- "example": { "css": 15343, "gif": 23178, "html": 1234213, "javascript": 318236, "jpeg": 1982048 },
+ "example": {
+ "css": 15343,
+ "gif": 23178,
+ "html": 1234213,
+ "javascript": 318236,
+ "jpeg": 1982048
+ },
"type": "object"
},
"country": {
@@ -16519,23 +18192,47 @@
"ssl": {
"description": "A break down of requests served over HTTPS.",
"properties": {
- "encrypted": { "description": "The number of requests served over HTTPS.", "type": "integer" },
- "unencrypted": { "description": "The number of requests served over HTTP.", "type": "integer" }
+ "encrypted": {
+ "description": "The number of requests served over HTTPS.",
+ "type": "integer"
+ },
+ "unencrypted": {
+ "description": "The number of requests served over HTTP.",
+ "type": "integer"
+ }
},
"type": "object"
},
"ssl_protocols": {
"description": "A breakdown of requests by their SSL protocol.",
"properties": {
- "TLSv1": { "description": "The number of requests served over TLS v1.0.", "type": "integer" },
- "TLSv1.1": { "description": "The number of requests served over TLS v1.1.", "type": "integer" },
- "TLSv1.2": { "description": "The number of requests served over TLS v1.2.", "type": "integer" },
- "TLSv1.3": { "description": "The number of requests served over TLS v1.3.", "type": "integer" },
- "none": { "description": "The number of requests served over HTTP.", "type": "integer" }
+ "TLSv1": {
+ "description": "The number of requests served over TLS v1.0.",
+ "type": "integer"
+ },
+ "TLSv1.1": {
+ "description": "The number of requests served over TLS v1.1.",
+ "type": "integer"
+ },
+ "TLSv1.2": {
+ "description": "The number of requests served over TLS v1.2.",
+ "type": "integer"
+ },
+ "TLSv1.3": {
+ "description": "The number of requests served over TLS v1.3.",
+ "type": "integer"
+ },
+ "none": {
+ "description": "The number of requests served over HTTP.",
+ "type": "integer"
+ }
},
"type": "object"
},
- "uncached": { "description": "Total number of requests served from the origin.", "type": "integer" }
+ "uncached": {
+ "description": "Total number of requests served from the origin.",
+ "type": "integer"
+ }
},
"type": "object"
},
@@ -16555,7 +18252,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/ip_components-schemas-ip" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/ip_components-schemas-ip" },
+ "type": "array"
+ }
}
}
]
@@ -16630,7 +18330,11 @@
"data": {
"items": {
"properties": {
- "metrics": { "description": "List of metrics returned by the query.", "items": {}, "type": "array" }
+ "metrics": {
+ "description": "List of metrics returned by the query.",
+ "items": {},
+ "type": "array"
+ }
},
"required": ["metrics"],
"type": "object"
@@ -16711,7 +18415,10 @@
},
"schemas-rule_identifier": { "example": "2890e6fa406311ed9b5a23f70f6fb8cf" },
"schemas-rules": {
- "additionalProperties": { "allOf": [{ "$ref": "#/components/schemas/waf_action" }], "example": "default" },
+ "additionalProperties": {
+ "allOf": [{ "$ref": "#/components/schemas/waf_action" }],
+ "example": "default"
+ },
"description": "An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.",
"example": { "100015": "disable" },
"type": "object"
@@ -16719,7 +18426,11 @@
"schemas-rules_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/rule_result" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/rule_result" }, "type": "array" }
+ }
+ }
]
},
"schemas-ruleset": {
@@ -16916,7 +18627,10 @@
},
"type": "array"
},
- "validation_records": { "items": { "$ref": "#/components/schemas/validation_record" }, "type": "array" },
+ "validation_records": {
+ "items": { "$ref": "#/components/schemas/validation_record" },
+ "type": "array"
+ },
"wildcard": {
"description": "Indicates whether the certificate covers a wildcard.",
"example": false,
@@ -16987,7 +18701,9 @@
"properties": {
"cloudflare_endpoint": { "$ref": "#/components/schemas/cloudflare_ipsec_endpoint" },
"customer_endpoint": { "$ref": "#/components/schemas/customer_ipsec_endpoint" },
- "description": { "$ref": "#/components/schemas/ipsec-tunnel_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/ipsec-tunnel_components-schemas-description"
+ },
"interface_address": { "$ref": "#/components/schemas/interface_address" },
"name": { "$ref": "#/components/schemas/ipsec-tunnel_components-schemas-name" },
"psk": { "$ref": "#/components/schemas/psk" }
@@ -17029,7 +18745,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/tunnel" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/tunnel" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -17037,7 +18755,10 @@
"schemas-tunnel_response_single": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/tunnel" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/tunnel" } },
+ "type": "object"
+ }
]
},
"schemas-tunnel_single_response": {
@@ -17056,7 +18777,10 @@
"properties": {
"result": {
"properties": {
- "ipsec_tunnels": { "items": { "$ref": "#/components/schemas/ipsec-tunnel" }, "type": "array" }
+ "ipsec_tunnels": {
+ "items": { "$ref": "#/components/schemas/ipsec-tunnel" },
+ "type": "array"
+ }
}
}
}
@@ -17102,7 +18826,11 @@
"schemas-validate_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "properties": { "valid": { "example": true, "type": "boolean" } } } } }
+ {
+ "properties": {
+ "result": { "properties": { "valid": { "example": true, "type": "boolean" } } }
+ }
+ }
]
},
"schemas-validation_method": {
@@ -17152,8 +18880,14 @@
"readOnly": true,
"type": "string"
},
- "schemas-virtual-dns": { "allOf": [{ "$ref": "#/components/schemas/virtual-dns" }], "type": "object" },
- "schemas-weight": { "description": "Optional weight of the ECMP scope - if provided.", "type": "integer" },
+ "schemas-virtual-dns": {
+ "allOf": [{ "$ref": "#/components/schemas/virtual-dns" }],
+ "type": "object"
+ },
+ "schemas-weight": {
+ "description": "Optional weight of the ECMP scope - if provided.",
+ "type": "integer"
+ },
"schemas-width": {
"description": "Maximum width in image pixels.",
"example": 1366,
@@ -17171,7 +18905,11 @@
},
"type": "array"
},
- "scope": { "description": "The scope of the URL normalization.", "example": "incoming", "type": "string" },
+ "scope": {
+ "description": "The scope of the URL normalization.",
+ "example": "incoming",
+ "type": "string"
+ },
"script": {
"properties": {
"added_at": { "example": "2021-08-18T10:51:10.09615Z" },
@@ -17185,7 +18923,9 @@
"js_integrity_score": { "example": 10 },
"last_seen_at": { "example": "2021-09-02T09:57:54Z" },
"page_urls": { "example": ["blog.cloudflare.com/page1", "blog.cloudflare.com/page2"] },
- "url": { "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js" },
+ "url": {
+ "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"
+ },
"url_contains_cdn_cgi_path": { "example": false }
}
},
@@ -17244,7 +18984,10 @@
},
"type": "object"
},
- "search_result": { "properties": { "result": { "$ref": "#/components/schemas/search" } }, "type": "object" },
+ "search_result": {
+ "properties": { "result": { "$ref": "#/components/schemas/search" } },
+ "type": "object"
+ },
"seat": {
"properties": {
"access_seat": { "$ref": "#/components/schemas/access_seat" },
@@ -17269,7 +19012,11 @@
"seats_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/seats" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/seats" }, "type": "array" }
+ }
+ }
]
},
"seats_definition": {
@@ -17363,14 +19110,22 @@
"custom_deny_url": { "$ref": "#/components/schemas/custom_deny_url" },
"domain": { "$ref": "#/components/schemas/schemas-domain" },
"enable_binding_cookie": { "$ref": "#/components/schemas/enable_binding_cookie" },
- "http_only_cookie_attribute": { "$ref": "#/components/schemas/http_only_cookie_attribute" },
+ "http_only_cookie_attribute": {
+ "$ref": "#/components/schemas/http_only_cookie_attribute"
+ },
"logo_url": { "$ref": "#/components/schemas/logo_url" },
"name": { "$ref": "#/components/schemas/apps_components-schemas-name" },
- "same_site_cookie_attribute": { "$ref": "#/components/schemas/same_site_cookie_attribute" },
+ "same_site_cookie_attribute": {
+ "$ref": "#/components/schemas/same_site_cookie_attribute"
+ },
"service_auth_401_redirect": { "$ref": "#/components/schemas/service_auth_401_redirect" },
"session_duration": { "$ref": "#/components/schemas/session_duration" },
"skip_interstitial": { "$ref": "#/components/schemas/skip_interstitial" },
- "type": { "description": "The application type.", "example": "self_hosted", "type": "string" }
+ "type": {
+ "description": "The application type.",
+ "example": "self_hosted",
+ "type": "string"
+ }
},
"title": "Self Hosted Application",
"type": "object"
@@ -17439,7 +19194,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/service-tokens" }, "type": "array" } }
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/service-tokens" },
+ "type": "array"
+ }
+ }
}
]
},
@@ -17456,8 +19216,16 @@
},
"service_mode_v2": {
"properties": {
- "mode": { "description": "The mode to run the WARP client under.", "example": "proxy", "type": "string" },
- "port": { "description": "The port number when used with proxy mode.", "example": 3000, "type": "number" }
+ "mode": {
+ "description": "The mode to run the WARP client under.",
+ "example": "proxy",
+ "type": "string"
+ },
+ "port": {
+ "description": "The port number when used with proxy mode.",
+ "example": 3000,
+ "type": "number"
+ }
},
"type": "object"
},
@@ -17584,8 +19352,9 @@
"min": 1800,
"name": "value",
"suggested_values": [
- 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600,
- 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000
+ 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800,
+ 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400,
+ 31536000
],
"type": "range"
}
@@ -17612,7 +19381,13 @@
"name": "header",
"type": "select"
},
- { "allowEmpty": false, "choices": ["resolved"], "multiple": true, "name": "host", "type": "select" },
+ {
+ "allowEmpty": false,
+ "choices": ["resolved"],
+ "multiple": true,
+ "name": "host",
+ "type": "select"
+ },
{
"allowEmpty": true,
"choices": ["include", "check_presence"],
@@ -17644,7 +19419,10 @@
}
]
},
- { "id": "cache_ttl_by_status", "properties": [{ "allowEmpty": false, "name": "value", "type": "object" }] },
+ {
+ "id": "cache_ttl_by_status",
+ "properties": [{ "allowEmpty": false, "name": "value", "type": "object" }]
+ },
{ "id": "disable_apps", "properties": [] },
{ "id": "disable_performance", "properties": [] },
{ "id": "disable_security", "properties": [] },
@@ -17656,8 +19434,8 @@
"min": 7200,
"name": "value",
"suggested_values": [
- 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 518400,
- 604800, 1209600, 2419200
+ 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200,
+ 345600, 432000, 518400, 604800, 1209600, 2419200
],
"type": "range"
}
@@ -17701,7 +19479,12 @@
{
"id": "ssl",
"properties": [
- { "choices": ["off", "flexible", "full", "strict"], "multiple": false, "name": "value", "type": "choice" }
+ {
+ "choices": ["off", "flexible", "full", "strict"],
+ "multiple": false,
+ "name": "value",
+ "type": "choice"
+ }
]
}
],
@@ -17713,7 +19496,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "Zone setting identifier.", "enum": ["sha1_support"], "example": "sha1_support" },
+ "id": {
+ "description": "Zone setting identifier.",
+ "enum": ["sha1_support"],
+ "example": "sha1_support"
+ },
"value": { "$ref": "#/components/schemas/sha1_support_value" }
}
}
@@ -17828,8 +19615,12 @@
},
"single_request_outgoing": {
"properties": {
- "id": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" },
- "name": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-name" },
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ },
+ "name": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-name"
+ },
"peers": { "$ref": "#/components/schemas/peers" }
},
"required": ["id", "name", "peers"]
@@ -17856,9 +19647,13 @@
"auto_refresh_seconds": { "$ref": "#/components/schemas/auto_refresh_seconds" },
"checked_time": { "$ref": "#/components/schemas/time" },
"created_time": { "$ref": "#/components/schemas/time" },
- "id": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ },
"modified_time": { "$ref": "#/components/schemas/time" },
- "name": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-name"
+ },
"peers": { "$ref": "#/components/schemas/peers" },
"soa_serial": { "$ref": "#/components/schemas/soa_serial" }
},
@@ -17877,9 +19672,13 @@
"properties": {
"checked_time": { "$ref": "#/components/schemas/time" },
"created_time": { "$ref": "#/components/schemas/time" },
- "id": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ },
"last_transferred_time": { "$ref": "#/components/schemas/time" },
- "name": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-name"
+ },
"peers": { "$ref": "#/components/schemas/peers" },
"soa_serial": { "$ref": "#/components/schemas/soa_serial" }
},
@@ -17897,7 +19696,9 @@
"result": {
"properties": {
"created_at": { "$ref": "#/components/schemas/timestamp" },
- "description": { "$ref": "#/components/schemas/lists_components-schemas-description-2" },
+ "description": {
+ "$ref": "#/components/schemas/lists_components-schemas-description-2"
+ },
"id": { "$ref": "#/components/schemas/lists_components-schemas-uuid" },
"items": { "$ref": "#/components/schemas/schemas-items" },
"name": { "$ref": "#/components/schemas/lists_components-schemas-name-2" },
@@ -18010,7 +19811,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/split_tunnel_include" },
+ "type": "array"
+ }
}
}
]
@@ -18018,13 +19822,24 @@
"split_tunnel_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/split_tunnel" },
+ "type": "array"
+ }
+ }
+ }
]
},
"ssh_props": {
"allOf": [
{ "$ref": "#/components/schemas/self_hosted_props" },
- { "properties": { "type": { "description": "The application type.", "example": "ssh", "type": "string" } } }
+ {
+ "properties": {
+ "type": { "description": "The application type.", "example": "ssh", "type": "string" }
+ }
+ }
]
},
"ssl": {
@@ -18080,8 +19895,12 @@
"properties": {
"result": {
"properties": {
- "status": { "$ref": "#/components/schemas/validation_method_components-schemas-status" },
- "validation_method": { "$ref": "#/components/schemas/validation_method_definition" }
+ "status": {
+ "$ref": "#/components/schemas/validation_method_components-schemas-status"
+ },
+ "validation_method": {
+ "$ref": "#/components/schemas/validation_method_definition"
+ }
}
}
}
@@ -18096,7 +19915,14 @@
},
"ssl_verification_response_collection": {
"allOf": [
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/verification" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/verification" },
+ "type": "array"
+ }
+ }
+ }
]
},
"sslpost": {
@@ -18159,13 +19985,21 @@
"enum": ["on", "off"],
"example": "on"
},
- "http2": { "description": "Whether or not HTTP2 is enabled.", "enum": ["on", "off"], "example": "on" },
+ "http2": {
+ "description": "Whether or not HTTP2 is enabled.",
+ "enum": ["on", "off"],
+ "example": "on"
+ },
"min_tls_version": {
"description": "The minimum TLS version supported.",
"enum": ["1.0", "1.1", "1.2", "1.3"],
"example": "1.2"
},
- "tls_1_3": { "description": "Whether or not TLS 1.3 is enabled.", "enum": ["on", "off"], "example": "on" }
+ "tls_1_3": {
+ "description": "Whether or not TLS 1.3 is enabled.",
+ "enum": ["on", "off"],
+ "example": "on"
+ }
},
"type": "object"
},
@@ -18212,7 +20046,15 @@
},
"state": {
"description": "The state that the subscription is in.",
- "enum": ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"],
+ "enum": [
+ "Trial",
+ "Provisioned",
+ "Paid",
+ "AwaitingPayment",
+ "Cancelled",
+ "Failed",
+ "Expired"
+ ],
"example": "Paid",
"readOnly": true,
"type": "string"
@@ -18231,10 +20073,16 @@
"properties": {
"result": {
"properties": {
- "estimated_queued_users": { "$ref": "#/components/schemas/estimated_queued_users" },
- "estimated_total_active_users": { "$ref": "#/components/schemas/estimated_total_active_users" },
+ "estimated_queued_users": {
+ "$ref": "#/components/schemas/estimated_queued_users"
+ },
+ "estimated_total_active_users": {
+ "$ref": "#/components/schemas/estimated_total_active_users"
+ },
"event_id": { "$ref": "#/components/schemas/status_event_id" },
- "max_estimated_time_minutes": { "$ref": "#/components/schemas/max_estimated_time_minutes" },
+ "max_estimated_time_minutes": {
+ "$ref": "#/components/schemas/max_estimated_time_minutes"
+ },
"status": { "$ref": "#/components/schemas/waitingroom_components-schemas-status" }
},
"type": "object"
@@ -18243,7 +20091,10 @@
}
]
},
- "std_dev_rtt_ms": { "description": "Standard deviation of the RTTs in ms.", "type": "number" },
+ "std_dev_rtt_ms": {
+ "description": "Standard deviation of the RTTs in ms.",
+ "type": "number"
+ },
"steering_policy": {
"default": "\"\"",
"description": "Steering Policy for this load balancer.\n- `\"off\"`: Use `default_pools`.\n- `\"geo\"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.\n- `\"random\"`: Select a pool randomly.\n- `\"dynamic_latency\"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).\n- `\"proximity\"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.\n- `\"\"`: Will map to `\"geo\"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `\"off\"`.",
@@ -18296,7 +20147,9 @@
"properties": {
"beta": { "$ref": "#/components/schemas/beta" },
"class": { "$ref": "#/components/schemas/class" },
- "description": { "$ref": "#/components/schemas/categories_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/categories_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/categories_components-schemas-id" },
"name": { "$ref": "#/components/schemas/categories_components-schemas-name" }
},
@@ -18310,10 +20163,17 @@
"subdomain-response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "properties": { "name": { "readOnly": true } }, "type": "object" } } }
+ {
+ "properties": {
+ "result": { "properties": { "name": { "readOnly": true } }, "type": "object" }
+ }
+ }
]
},
- "subscription": { "allOf": [{ "$ref": "#/components/schemas/subscription-v2" }], "type": "object" },
+ "subscription": {
+ "allOf": [{ "$ref": "#/components/schemas/subscription-v2" }],
+ "type": "object"
+ },
"subscription-v2": {
"properties": {
"app": { "properties": { "install_id": { "$ref": "#/components/schemas/install_id" } } },
@@ -18407,7 +20267,12 @@
},
"targets": {
"description": "The rule targets to evaluate on each request.",
- "example": [{ "constraint": { "operator": "matches", "value": "*example.com/images/*" }, "target": "url" }],
+ "example": [
+ {
+ "constraint": { "operator": "matches", "value": "*example.com/images/*" },
+ "target": "url"
+ }
+ ],
"items": { "$ref": "#/components/schemas/target" },
"type": "array"
},
@@ -18432,7 +20297,9 @@
"teamnet": {
"properties": {
"comment": { "$ref": "#/components/schemas/comment" },
- "created_at": { "description": "Timestamps when the route was created, formatted in RFC 3339." },
+ "created_at": {
+ "description": "Timestamps when the route was created, formatted in RFC 3339."
+ },
"deleted_at": {
"description": "If present, indicates route was deleted at the given date (formatted in RFC 3339). If absent, route has not been deleted.",
"example": "2021-01-25T18:22:34.317854Z",
@@ -18441,10 +20308,16 @@
"readOnly": true,
"type": "string"
},
- "network": { "description": "CIDR notation of the IPv4 or IPv6 range of the network the route connects to." },
+ "network": {
+ "description": "CIDR notation of the IPv4 or IPv6 range of the network the route connects to."
+ },
"tunnel_id": { "description": "UUID of the Tunnel the route belongs to." },
- "tunnel_name": { "description": "User-friendly name of the Tunnel the route belongs to." },
- "virtual_network_id": { "description": "UUID of the virtual network this route belongs to." }
+ "tunnel_name": {
+ "description": "User-friendly name of the Tunnel the route belongs to."
+ },
+ "virtual_network_id": {
+ "description": "UUID of the virtual network this route belongs to."
+ }
},
"required": ["network", "tunnel_id", "comment", "created_at"],
"type": "object"
@@ -18464,8 +20337,15 @@
"example": "be27f2429421e12f200cab1da43ba301bdc70e1d",
"type": "string"
},
- "body_size": { "description": "Size of the body in bytes.", "example": "63910 bytes", "type": "string" },
- "cf-cache-status": { "description": "Lists any `cf-cache-status` present.", "type": "string" },
+ "body_size": {
+ "description": "Size of the body in bytes.",
+ "example": "63910 bytes",
+ "type": "string"
+ },
+ "cf-cache-status": {
+ "description": "Lists any `cf-cache-status` present.",
+ "type": "string"
+ },
"cf-ray": {
"description": "Lists any `cf-ray` present.",
"example": "1ddd7570575207d9-LAX",
@@ -18488,8 +20368,16 @@
"example": "0.239013s",
"type": "string"
},
- "host_name": { "description": "The hostname queried.", "example": "www.example.com", "type": "string" },
- "http_status": { "description": "The HTTP status response code.", "example": 200, "type": "number" },
+ "host_name": {
+ "description": "The hostname queried.",
+ "example": "www.example.com",
+ "type": "string"
+ },
+ "http_status": {
+ "description": "The HTTP status response code.",
+ "example": 200,
+ "type": "number"
+ },
"method": {
"description": "HTTP Method used to test the connection.",
"enum": ["GET", "POST"],
@@ -18510,7 +20398,11 @@
"example": "on",
"type": "string"
},
- "response_status": { "description": "HTTP Status code.", "example": "200 OK", "type": "string" },
+ "response_status": {
+ "description": "HTTP Status code.",
+ "example": "200 OK",
+ "type": "string"
+ },
"url": {
"description": "Url of the domain you can compare the connection to.",
"example": "https://www.cloudflare.com",
@@ -18522,7 +20414,11 @@
"test_connection_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/test_connection_properties" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/test_connection_properties" }
+ }
+ }
]
},
"threats": {
@@ -18659,7 +20555,11 @@
"tls-settings": {
"description": "TLS interception settings.",
"properties": {
- "enabled": { "description": "Enable inspecting encrypted HTTP traffic.", "example": true, "type": "boolean" }
+ "enabled": {
+ "description": "Enable inspecting encrypted HTTP traffic.",
+ "example": true,
+ "type": "boolean"
+ }
},
"type": "object"
},
@@ -18668,7 +20568,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "Zone setting identifier.", "enum": ["tls_1_2_only"], "example": "tls_1_2_only" },
+ "id": {
+ "description": "Zone setting identifier.",
+ "enum": ["tls_1_2_only"],
+ "example": "tls_1_2_only"
+ },
"value": { "$ref": "#/components/schemas/tls_1_2_only_value" }
}
}
@@ -18687,7 +20591,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["tls_1_3"], "example": "tls_1_3" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["tls_1_3"],
+ "example": "tls_1_3"
+ },
"value": { "$ref": "#/components/schemas/tls_1_3_value" }
}
}
@@ -18764,8 +20672,12 @@
"properties": {
"result": {
"properties": {
- "certificate_authority": { "$ref": "#/components/schemas/schemas-certificate_authority" },
- "enabled": { "$ref": "#/components/schemas/total-tls_components-schemas-enabled" },
+ "certificate_authority": {
+ "$ref": "#/components/schemas/schemas-certificate_authority"
+ },
+ "enabled": {
+ "$ref": "#/components/schemas/total-tls_components-schemas-enabled"
+ },
"validity_days": { "$ref": "#/components/schemas/schemas-validity_days" }
}
}
@@ -18797,7 +20709,10 @@
},
"type": "object"
},
- "traceroute_components-schemas-ip": { "description": "IP address of the node.", "type": "string" },
+ "traceroute_components-schemas-ip": {
+ "description": "IP address of the node.",
+ "type": "string"
+ },
"traceroute_components-schemas-name": {
"description": "Host name of the address, this may be the same as the IP address.",
"type": "string"
@@ -18812,7 +20727,14 @@
"traceroute_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/target_result" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/target_result" },
+ "type": "array"
+ }
+ }
+ }
]
},
"traceroute_time_ms": { "description": "Total time of traceroute in ms.", "type": "integer" },
@@ -18827,7 +20749,16 @@
}
],
"description": "When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.",
- "required": ["id", "description", "priority", "allowed_modes", "default_mode", "mode", "group", "package_id"],
+ "required": [
+ "id",
+ "description",
+ "priority",
+ "allowed_modes",
+ "default_mode",
+ "mode",
+ "group",
+ "package_id"
+ ],
"title": "Traditional (allow) WAF rule"
},
"traditional_deny_rule": {
@@ -18842,7 +20773,16 @@
}
],
"description": "When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.",
- "required": ["id", "description", "priority", "allowed_modes", "default_mode", "mode", "group", "package_id"],
+ "required": [
+ "id",
+ "description",
+ "priority",
+ "allowed_modes",
+ "default_mode",
+ "mode",
+ "group",
+ "package_id"
+ ],
"title": "Traditional (deny) WAF rule"
},
"traffic": {
@@ -18864,14 +20804,22 @@
"description": "Form of authorization has been accepted by the registrant.",
"example": "needed"
},
- "approve_transfer": { "description": "Shows transfer status with the registry.", "example": "unknown" },
+ "approve_transfer": {
+ "description": "Shows transfer status with the registry.",
+ "example": "unknown"
+ },
"can_cancel_transfer": {
"description": "Indicates if cancellation is still possible.",
"example": true,
"type": "boolean"
},
- "disable_privacy": { "description": "Privacy guards are disabled at the foreign registrar." },
- "enter_auth_code": { "description": "Auth code has been entered and verified.", "example": "needed" },
+ "disable_privacy": {
+ "description": "Privacy guards are disabled at the foreign registrar."
+ },
+ "enter_auth_code": {
+ "description": "Auth code has been entered and verified.",
+ "example": "needed"
+ },
"unlock_domain": { "description": "Domain is unlocked at the foreign registrar." }
}
},
@@ -18928,7 +20876,11 @@
"tsig_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/tsig" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/tsig" }, "type": "array" }
+ }
+ }
]
},
"tsig_id": {
@@ -18952,7 +20904,9 @@
"connections": { "$ref": "#/components/schemas/connections" },
"conns_active_at": { "$ref": "#/components/schemas/conns_active_at" },
"conns_inactive_at": { "$ref": "#/components/schemas/conns_inactive_at" },
- "created_at": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-created_at" },
+ "created_at": {
+ "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-created_at"
+ },
"deleted_at": { "$ref": "#/components/schemas/schemas-deleted_at" },
"id": { "$ref": "#/components/schemas/tunnel_id" },
"name": { "$ref": "#/components/schemas/tunnel_name" },
@@ -18965,14 +20919,21 @@
"properties": {
"cloudflare_gre_endpoint": { "$ref": "#/components/schemas/cloudflare_gre_endpoint" },
"customer_gre_endpoint": { "$ref": "#/components/schemas/customer_gre_endpoint" },
- "description": { "$ref": "#/components/schemas/gre-tunnel_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/gre-tunnel_components-schemas-description"
+ },
"health_check": { "$ref": "#/components/schemas/health_check" },
"interface_address": { "$ref": "#/components/schemas/interface_address" },
"mtu": { "$ref": "#/components/schemas/mtu" },
"name": { "$ref": "#/components/schemas/gre-tunnel_components-schemas-name" },
"ttl": { "$ref": "#/components/schemas/components-schemas-ttl" }
},
- "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"],
+ "required": [
+ "name",
+ "customer_gre_endpoint",
+ "cloudflare_gre_endpoint",
+ "interface_address"
+ ],
"type": "object"
},
"tunnel_connection": {
@@ -18992,7 +20953,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/tunnel_connection" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/tunnel_connection" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -19067,7 +21031,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/argo-tunnel" }, "type": "array" } },
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/argo-tunnel" }, "type": "array" }
+ },
"type": "object"
}
]
@@ -19090,7 +21056,9 @@
{ "properties": { "result": { "properties": { "gre_tunnel": { "type": "object" } } } } }
]
},
- "tunnel_update_request": { "allOf": [{ "$ref": "#/components/schemas/tunnel_add_single_request" }] },
+ "tunnel_update_request": {
+ "allOf": [{ "$ref": "#/components/schemas/tunnel_add_single_request" }]
+ },
"tunnels_collection_response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
@@ -19098,7 +21066,10 @@
"properties": {
"result": {
"properties": {
- "gre_tunnels": { "items": { "$ref": "#/components/schemas/gre-tunnel" }, "type": "array" }
+ "gre_tunnels": {
+ "items": { "$ref": "#/components/schemas/gre-tunnel" },
+ "type": "array"
+ }
}
}
}
@@ -19124,7 +21095,10 @@
"readOnly": true,
"type": "string"
},
- "ua-rules": { "allOf": [{ "$ref": "#/components/schemas/firewalluablock" }], "type": "object" },
+ "ua-rules": {
+ "allOf": [{ "$ref": "#/components/schemas/firewalluablock" }],
+ "type": "object"
+ },
"ua-rules_components-schemas-description": {
"description": "An informative summary of the rule.",
"example": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack",
@@ -19147,11 +21121,19 @@
"uid": { "description": "The unique API identifier for the user." },
"uniques": {
"properties": {
- "all": { "description": "Total number of unique IP addresses within the time range.", "type": "integer" }
+ "all": {
+ "description": "Total number of unique IP addresses within the time range.",
+ "type": "integer"
+ }
},
"type": "object"
},
- "unit_price": { "description": "The unit price of the addon.", "example": 1, "readOnly": true, "type": "number" },
+ "unit_price": {
+ "description": "The unit price of the addon.",
+ "example": 1,
+ "readOnly": true,
+ "type": "number"
+ },
"universal": {
"properties": { "enabled": { "$ref": "#/components/schemas/components-schemas-enabled" } },
"type": "object"
@@ -19172,7 +21154,9 @@
"properties": {
"enabled": { "$ref": "#/components/schemas/script-monitor_components-schemas-enabled" },
"updated_at": { "$ref": "#/components/schemas/schemas-updated_at" },
- "use_cloudflare_reporting_endpoint": { "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint" },
+ "use_cloudflare_reporting_endpoint": {
+ "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint"
+ },
"use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" }
}
},
@@ -19198,7 +21182,11 @@
"items": { "$ref": "#/components/schemas/custom_entry" },
"type": "array"
},
- "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" }
+ "name": {
+ "description": "The name of the profile.",
+ "example": "Generic CVV Card Number",
+ "type": "string"
+ }
},
"title": "Update custom profile",
"type": "object"
@@ -19220,7 +21208,11 @@
"description": "The entries for this profile.",
"items": {
"properties": {
- "enabled": { "description": "Wheter the entry is enabled or not.", "example": true, "type": "boolean" },
+ "enabled": {
+ "description": "Wheter the entry is enabled or not.",
+ "example": true,
+ "type": "boolean"
+ },
"id": { "$ref": "#/components/schemas/entry_id" }
}
},
@@ -19352,7 +21344,11 @@
"description": "The constraint of a target.",
"type": "object"
},
- "target": { "description": "A target based on the URL of the request.", "enum": ["url"], "example": "url" }
+ "target": {
+ "description": "A target based on the URL of the request.",
+ "enum": ["url"],
+ "example": "url"
+ }
},
"type": "object"
},
@@ -19364,7 +21360,11 @@
"usage-model-response": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "properties": { "usage_model": { "readOnly": true } }, "type": "object" } } }
+ {
+ "properties": {
+ "result": { "properties": { "usage_model": { "readOnly": true } }, "type": "object" }
+ }
+ }
]
},
"use_cloudflare_reporting_endpoint": {
@@ -19381,7 +21381,11 @@
"properties": {
"email": { "$ref": "#/components/schemas/email" },
"id": { "$ref": "#/components/schemas/uuid" },
- "name": { "description": "The enrolled device user's name.", "example": "John Appleseed", "type": "string" }
+ "name": {
+ "description": "The enrolled device user's name.",
+ "example": "John Appleseed",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -19403,7 +21407,12 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/subscription" },
+ "type": "array"
+ }
+ },
"type": "object"
}
]
@@ -19456,7 +21465,11 @@
}
}
},
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/users" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/users" }, "type": "array" }
+ }
+ }
]
},
"uuid": {
@@ -19482,7 +21495,13 @@
},
"validate_pattern": {
"description": "A request to validate a pattern",
- "properties": { "regex": { "description": "The regex pattern.", "example": "^4[0-9]{6,}$", "type": "string" } },
+ "properties": {
+ "regex": {
+ "description": "The regex pattern.",
+ "example": "^4[0-9]{6,}$",
+ "type": "string"
+ }
+ },
"required": ["regex"],
"title": "Pattern",
"type": "object"
@@ -19595,7 +21614,10 @@
"required": ["options"],
"type": "object"
},
- "variant_public_request": { "properties": { "hero": { "type": "object" } }, "type": "object" },
+ "variant_public_request": {
+ "properties": { "hero": { "type": "object" } },
+ "type": "object"
+ },
"variant_response": { "properties": { "variant": { "type": "object" } }, "type": "object" },
"variant_simple_response": {
"allOf": [
@@ -19608,14 +21630,22 @@
{ "$ref": "#/components/schemas/components-schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["variants"], "example": "variants" }
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["variants"],
+ "example": "variants"
+ }
}
}
],
"description": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.",
"title": "Variants Caching"
},
- "variants_components-schemas-identifier": { "example": "hero", "maxLength": 99, "pattern": "^[a-zA-Z0-9]$" },
+ "variants_components-schemas-identifier": {
+ "example": "hero",
+ "maxLength": 99,
+ "pattern": "^[a-zA-Z0-9]$"
+ },
"variants_response": {
"properties": { "variants": { "$ref": "#/components/schemas/variant_public_request" } },
"type": "object"
@@ -19625,7 +21655,10 @@
"result": {
"allOf": [
{ "$ref": "#/components/schemas/variants" },
- { "properties": { "value": { "$ref": "#/components/schemas/variants_value" } }, "required": ["value"] }
+ {
+ "properties": { "value": { "$ref": "#/components/schemas/variants_value" } },
+ "required": ["value"]
+ }
]
}
}
@@ -19828,7 +21861,11 @@
"video_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/videos" }, "type": "array" } } },
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/videos" }, "type": "array" }
+ }
+ },
{
"properties": {
"range": {
@@ -19923,7 +21960,9 @@
"virtual-network": {
"properties": {
"comment": { "$ref": "#/components/schemas/schemas-comment" },
- "created_at": { "description": "Timestamp of when the virtual network was created, formatted in RFC 3339." },
+ "created_at": {
+ "description": "Timestamp of when the virtual network was created, formatted in RFC 3339."
+ },
"deleted_at": {
"description": "If present, indicates that the virtual network was deleted at the given date (formatted in RFC 3339). If absent, the virtual network has not been deleted.",
"example": "2021-01-25T18:22:34.317854Z",
@@ -19962,7 +22001,11 @@
"virtual_dns_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/virtual-dns" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/virtual-dns" }, "type": "array" }
+ }
+ }
]
},
"virtual_dns_single_response": {
@@ -19974,7 +22017,11 @@
"vnc_props": {
"allOf": [
{ "$ref": "#/components/schemas/self_hosted_props" },
- { "properties": { "type": { "description": "The application type.", "example": "vnc", "type": "string" } } }
+ {
+ "properties": {
+ "type": { "description": "The application type.", "example": "vnc", "type": "string" }
+ }
+ }
]
},
"vnet_id": {
@@ -19994,7 +22041,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/virtual-network" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/virtual-network" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -20046,7 +22096,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/waiting_room_id" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/waiting_room_id" } },
+ "type": "object"
+ }
}
}
]
@@ -20057,7 +22110,9 @@
"created_on": { "$ref": "#/components/schemas/timestamp" },
"custom_page_html": { "$ref": "#/components/schemas/custom_page_html" },
"default_template_language": { "$ref": "#/components/schemas/default_template_language" },
- "description": { "$ref": "#/components/schemas/waitingroom_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-description"
+ },
"disable_session_renewal": { "$ref": "#/components/schemas/disable_session_renewal" },
"host": { "$ref": "#/components/schemas/components-schemas-host" },
"id": { "$ref": "#/components/schemas/waiting_room_id" },
@@ -20065,7 +22120,9 @@
"modified_on": { "$ref": "#/components/schemas/timestamp" },
"name": { "$ref": "#/components/schemas/waitingroom_components-schemas-name" },
"new_users_per_minute": { "$ref": "#/components/schemas/new_users_per_minute" },
- "next_event_prequeue_start_time": { "$ref": "#/components/schemas/next_event_prequeue_start_time" },
+ "next_event_prequeue_start_time": {
+ "$ref": "#/components/schemas/next_event_prequeue_start_time"
+ },
"next_event_start_time": { "$ref": "#/components/schemas/next_event_start_time" },
"path": { "$ref": "#/components/schemas/schemas-path" },
"queue_all": { "$ref": "#/components/schemas/queue_all" },
@@ -20090,7 +22147,11 @@
"waitingroom_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/waitingroom" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/waitingroom" }, "type": "array" }
+ }
+ }
]
},
"waitingroom_components-schemas-single_response": {
@@ -20110,8 +22171,16 @@
{
"properties": {
"domain": { "example": "authdomain.cloudflareaccess.com/warp", "readOnly": true },
- "name": { "default": "Warp Login App", "example": "Warp Login App", "readOnly": true },
- "type": { "description": "The application type.", "example": "warp", "type": "string" }
+ "name": {
+ "default": "Warp Login App",
+ "example": "Warp Login App",
+ "readOnly": true
+ },
+ "type": {
+ "description": "The application type.",
+ "example": "warp",
+ "type": "string"
+ }
}
}
]
@@ -20170,7 +22239,11 @@
"watermark_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/watermarks" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/watermarks" }, "type": "array" }
+ }
+ }
]
},
"watermark_response_single": {
@@ -20212,7 +22285,9 @@
"web3-hostname": {
"properties": {
"created_on": { "$ref": "#/components/schemas/timestamp" },
- "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-description"
+ },
"dnslink": { "$ref": "#/components/schemas/dnslink" },
"id": { "$ref": "#/components/schemas/common_components-schemas-identifier" },
"modified_on": { "$ref": "#/components/schemas/timestamp" },
@@ -20290,7 +22365,10 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid" } }, "type": "object" }
+ "result": {
+ "properties": { "id": { "$ref": "#/components/schemas/uuid" } },
+ "type": "object"
+ }
}
}
]
@@ -20303,7 +22381,11 @@
"webhooks_components-schemas-response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
- { "properties": { "result": { "items": { "$ref": "#/components/schemas/webhooks" }, "type": "array" } } }
+ {
+ "properties": {
+ "result": { "items": { "$ref": "#/components/schemas/webhooks" }, "type": "array" }
+ }
+ }
]
},
"webhooks_components-schemas-single_response": {
@@ -20323,7 +22405,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["webp"], "example": "webp" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["webp"],
+ "example": "webp"
+ },
"value": { "$ref": "#/components/schemas/webp_value" }
}
}
@@ -20342,7 +22428,11 @@
{ "$ref": "#/components/schemas/schemas-base" },
{
"properties": {
- "id": { "description": "ID of the zone setting.", "enum": ["websockets"], "example": "websockets" },
+ "id": {
+ "description": "ID of the zone setting.",
+ "enum": ["websockets"],
+ "example": "websockets"
+ },
"value": { "$ref": "#/components/schemas/websockets_value" }
}
}
@@ -20397,7 +22487,11 @@
{ "properties": { "result": { "$ref": "#/components/schemas/whois" } } }
]
},
- "width": { "description": "The width of the image in pixels.", "readOnly": true, "type": "integer" },
+ "width": {
+ "description": "The width of the image in pixels.",
+ "readOnly": true,
+ "type": "integer"
+ },
"workspace_one_config_request": {
"properties": {
"api_url": {
@@ -20467,8 +22561,12 @@
"certificate": {
"$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"
},
- "enabled": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled" },
- "id": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" },
+ "enabled": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"
+ },
+ "id": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"
+ },
"private_key": { "$ref": "#/components/schemas/private_key" }
},
"type": "object"
@@ -20520,7 +22618,10 @@
"allOf": [{ "$ref": "#/components/schemas/components-schemas-zone" }],
"type": "object"
},
- "zone_identifier": { "description": "Identifier of the zone.", "example": "593c9c94de529bbbfaac7c53ced0447d" },
+ "zone_identifier": {
+ "description": "Identifier of the zone.",
+ "example": "593c9c94de529bbbfaac7c53ced0447d"
+ },
"zone_metadata": {
"properties": {
"enabled": {
@@ -20531,7 +22632,11 @@
},
"type": "object"
},
- "zone_name": { "description": "Name of the zone.", "example": "example.com", "type": "string" },
+ "zone_name": {
+ "description": "Name of the zone.",
+ "example": "example.com",
+ "type": "string"
+ },
"zone_settings_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
@@ -20561,19 +22666,36 @@
"properties": {
"configurations": { "$ref": "#/components/schemas/configurations" },
"created_on": { "$ref": "#/components/schemas/schemas-created_on" },
- "description": { "$ref": "#/components/schemas/lockdowns_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/lockdowns_components-schemas-description"
+ },
"id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" },
- "modified_on": { "$ref": "#/components/schemas/lockdowns_components-schemas-modified_on" },
+ "modified_on": {
+ "$ref": "#/components/schemas/lockdowns_components-schemas-modified_on"
+ },
"paused": { "$ref": "#/components/schemas/components-schemas-paused" },
"urls": { "$ref": "#/components/schemas/schemas-urls" }
},
- "required": ["id", "created_on", "modified_on", "paused", "description", "urls", "configurations"]
+ "required": [
+ "id",
+ "created_on",
+ "modified_on",
+ "paused",
+ "description",
+ "urls",
+ "configurations"
+ ]
},
"zonelockdown_response_collection": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-collection" },
{
- "properties": { "result": { "items": { "$ref": "#/components/schemas/zonelockdown" }, "type": "array" } },
+ "properties": {
+ "result": {
+ "items": { "$ref": "#/components/schemas/zonelockdown" },
+ "type": "array"
+ }
+ },
"required": ["result"],
"type": "object"
}
@@ -20617,7 +22739,11 @@
"operationId": "accounts-list-accounts",
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_collection" }
+ }
+ },
"description": "List Accounts response"
},
"4xx": {
@@ -20668,7 +22794,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Remove an account membership from an Address Map response"
},
"4xx": {
@@ -20715,7 +22845,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Add an account membership to an Address Map response"
},
"4xx": {
@@ -20753,7 +22887,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/address-maps_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/address-maps_components-schemas-response_collection"
+ }
}
},
"description": "List Address Maps response"
@@ -20763,7 +22899,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/address-maps_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/address-maps_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -20792,7 +22930,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/address-maps_components-schemas-description" }
+ "description": {
+ "$ref": "#/components/schemas/address-maps_components-schemas-description"
+ }
}
}
}
@@ -20801,7 +22941,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } }
+ },
"description": "Create Address Map response"
},
"4xx": {
@@ -20844,7 +22986,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Delete Address Map response"
},
"4xx": {
@@ -20884,7 +23030,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } }
+ },
"description": "Address Map Details response"
},
"4xx": {
@@ -20928,7 +23076,9 @@
"schema": {
"properties": {
"default_sni": { "$ref": "#/components/schemas/default_sni" },
- "description": { "$ref": "#/components/schemas/address-maps_components-schemas-description" }
+ "description": {
+ "$ref": "#/components/schemas/address-maps_components-schemas-description"
+ }
}
}
}
@@ -20939,7 +23089,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/address-maps_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/address-maps_components-schemas-single_response"
+ }
}
},
"description": "Update Address Map response"
@@ -20949,7 +23101,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/address-maps_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/address-maps_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -20990,7 +23144,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Remove an IP from an Address Map response"
},
"4xx": {
@@ -21037,7 +23195,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Add an IP to an Address Map response"
},
"4xx": {
@@ -21086,7 +23248,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Remove a zone membership from an Address Map response"
},
"4xx": {
@@ -21133,7 +23299,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Add a zone membership to an Address Map response"
},
"4xx": {
@@ -21187,7 +23357,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loa_upload_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/loa_upload_response" }
+ }
+ },
"description": "Upload LOA Document response"
},
"4xx": {
@@ -21235,7 +23409,9 @@
"4xx": {
"content": {
"application/json": {
- "schema": { "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }] }
+ "schema": {
+ "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }]
+ }
}
},
"description": "Download LOA Document response failure"
@@ -21262,7 +23438,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-response_collection"
+ }
}
},
"description": "List Prefixes response"
@@ -21272,7 +23450,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21315,7 +23495,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ }
}
},
"description": "Add Prefix response"
@@ -21325,7 +23507,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21360,7 +23544,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Delete Prefix response"
},
"4xx": {
@@ -21402,7 +23590,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ }
}
},
"description": "Prefix Details response"
@@ -21412,7 +23602,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21447,7 +23639,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-description" }
+ "description": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-description"
+ }
},
"required": ["description"]
}
@@ -21459,7 +23653,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ }
}
},
"description": "Update Prefix Description response"
@@ -21469,7 +23665,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/ipam-prefixes_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21503,7 +23701,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertised_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/advertised_response" }
+ }
+ },
"description": "Get Advertisement Status response"
},
"4xx": {
@@ -21545,7 +23747,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "advertised": { "$ref": "#/components/schemas/schemas-advertised" } },
+ "properties": {
+ "advertised": { "$ref": "#/components/schemas/schemas-advertised" }
+ },
"required": ["advertised"]
}
}
@@ -21554,7 +23758,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertised_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/advertised_response" }
+ }
+ },
"description": "Update Prefix Dynamic Advertisement Status response"
},
"4xx": {
@@ -21598,7 +23806,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-delegations_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-response_collection"
+ }
}
},
"description": "List Prefix Delegations response"
@@ -21608,7 +23818,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-delegations_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21644,7 +23856,9 @@
"schema": {
"properties": {
"cidr": { "$ref": "#/components/schemas/cidr" },
- "delegated_account_id": { "$ref": "#/components/schemas/delegated_account_identifier" }
+ "delegated_account_id": {
+ "$ref": "#/components/schemas/delegated_account_identifier"
+ }
},
"required": ["cidr", "delegated_account_id"]
}
@@ -21656,7 +23870,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-delegations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-single_response"
+ }
}
},
"description": "Create Prefix Delegation response"
@@ -21666,7 +23882,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-delegations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21709,7 +23927,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ipam-delegations_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-id_response"
+ }
}
},
"description": "Delete Prefix Delegation response"
@@ -21719,7 +23939,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/ipam-delegations_components-schemas-id_response" },
+ {
+ "$ref": "#/components/schemas/ipam-delegations_components-schemas-id_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -21748,7 +23970,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" }
+ }
},
"description": "Get account audit logs response"
},
@@ -21786,7 +24010,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/billing_response_single" }
+ }
+ },
"description": "Billing Profile Details response"
},
"4xx": {
@@ -21825,7 +24053,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_collection" }
+ }
},
"description": "List Cloudflare Tunnels response"
},
@@ -21880,7 +24110,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" }
+ }
},
"description": "Create Cloudflare Tunnel response"
},
@@ -21921,11 +24153,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "type": "object" } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" }
+ }
},
"description": "Delete Cloudflare Tunnel response"
},
@@ -21967,7 +24204,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" }
+ }
},
"description": "Get Cloudflare Tunnel response"
},
@@ -22027,7 +24266,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" }
+ }
},
"description": "Update Cloudflare Tunnel response"
},
@@ -22070,7 +24311,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/config_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/config_response_single" }
+ }
+ },
"description": "Get Configuration response"
},
"4xx": {
@@ -22125,7 +24370,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/config_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/config_response_single" }
+ }
+ },
"description": "Put Configuration response"
},
"4xx": {
@@ -22165,12 +24414,17 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "type": "object" } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-empty_response" }
+ "schema": {
+ "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-empty_response"
+ }
}
},
"description": "Clean Up Cloudflare Tunnel Connections response"
@@ -22180,7 +24434,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-empty_response" },
+ {
+ "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-empty_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -22213,7 +24469,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_connections_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_connections_response" }
+ }
},
"description": "List Cloudflare Tunnel Connections response"
},
@@ -22256,7 +24514,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_token" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_response_token" }
+ }
+ },
"description": "Get Cloudflare Tunnel Token response"
},
"4xx": {
@@ -22293,7 +24555,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" }
+ }
},
"description": "List custom pages response"
},
@@ -22327,7 +24591,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2"
+ }
},
{
"in": "path",
@@ -22339,7 +24605,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_single" }
+ }
},
"description": "Get a custom page response"
},
@@ -22371,7 +24639,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2"
+ }
},
{
"in": "path",
@@ -22397,7 +24667,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_single" }
+ }
},
"description": "Update a custom page response"
},
@@ -22452,7 +24724,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/traceroute_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/traceroute_response_collection" }
+ }
},
"description": "Traceroute response"
},
@@ -22473,7 +24747,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Traceroute",
"tags": ["Diagnostics"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/dlp/patterns/validate": {
@@ -22489,13 +24768,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_pattern" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/validate_pattern" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-validate_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-validate_response" }
+ }
},
"description": "Validate pattern response"
},
@@ -22534,7 +24817,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/profiles_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/profiles_components-schemas-response_collection"
+ }
}
},
"description": "List all profiles response"
@@ -22544,7 +24829,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/profiles_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/profiles_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -22571,13 +24858,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_custom_profiles" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_custom_profiles" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/create_custom_profile_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_custom_profile_response" }
+ }
},
"description": "Create custom profiles response"
},
@@ -22621,7 +24914,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Delete custom profile response"
},
"4xx": {
@@ -22661,7 +24958,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_profile_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_profile_response" }
+ }
+ },
"description": "Get custom profile response"
},
"4xx": {
@@ -22700,12 +25001,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_custom_profile" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_custom_profile" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_profile" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/custom_profile" } }
+ },
"description": "Update custom profile response"
},
"4xx": {
@@ -22748,7 +25055,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/predefined_profile_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/predefined_profile_response" }
+ }
},
"description": "Get predefined profile response"
},
@@ -22788,12 +25097,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_predefined_profile" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_predefined_profile" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/predefined_profile" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/predefined_profile" }
+ }
+ },
"description": "Update predefined profile response"
},
"4xx": {
@@ -22835,7 +25152,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/either_profile_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/either_profile_response" }
+ }
+ },
"description": "Get DLP Profile response"
},
"4xx": {
@@ -22872,7 +25193,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_firewall_response_collection" }
+ }
},
"description": "List DNS Firewall Clusters response"
},
@@ -22894,7 +25217,12 @@
"summary": "List DNS Firewall Clusters",
"tags": ["DNS Firewall"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create a configured DNS Firewall Cluster.",
@@ -22912,7 +25240,9 @@
"application/json": {
"schema": {
"properties": {
- "deprecate_any_requests": { "$ref": "#/components/schemas/deprecate_any_requests" },
+ "deprecate_any_requests": {
+ "$ref": "#/components/schemas/deprecate_any_requests"
+ },
"ecs_fallback": { "$ref": "#/components/schemas/ecs_fallback" },
"maximum_cache_ttl": { "$ref": "#/components/schemas/maximum_cache_ttl" },
"minimum_cache_ttl": { "$ref": "#/components/schemas/minimum_cache_ttl" },
@@ -22930,7 +25260,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" }
+ }
},
"description": "Create DNS Firewall Cluster response"
},
@@ -22952,7 +25284,12 @@
"summary": "Create DNS Firewall Cluster",
"tags": ["DNS Firewall"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/dns_firewall/{identifier}": {
@@ -22985,7 +25322,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
}
}
}
@@ -23008,7 +25347,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
}
}
}
@@ -23027,7 +25368,12 @@
"summary": "Delete DNS Firewall Cluster",
"tags": ["DNS Firewall"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Show a single configured DNS Firewall cluster for an account.",
@@ -23049,7 +25395,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" }
+ }
},
"description": "DNS Firewall Cluster Details response"
},
@@ -23071,7 +25419,12 @@
"summary": "DNS Firewall Cluster Details",
"tags": ["DNS Firewall"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Modify a DNS Firewall Cluster configuration.",
@@ -23091,13 +25444,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-dns-firewall" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-dns-firewall" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" }
+ }
},
"description": "Update DNS Firewall Cluster response"
},
@@ -23119,7 +25478,12 @@
"summary": "Update DNS Firewall Cluster",
"tags": ["DNS Firewall"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report": {
@@ -23147,7 +25511,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -23162,7 +25529,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -23204,7 +25574,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -23219,7 +25592,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -23252,7 +25628,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/destination_addresses_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/destination_addresses_response_collection"
+ }
}
},
"description": "List destination addresses response"
@@ -23274,7 +25652,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List destination addresses",
"tags": ["Email Routing destination addresses"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.list"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.email.routing.address.list"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"post": {
@@ -23290,14 +25670,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/create_destination_address_properties" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_destination_address_properties" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/destination_address_response_single" }
+ }
},
"description": "Create a destination address response"
},
@@ -23318,7 +25702,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create a destination address",
"tags": ["Email Routing destination addresses"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.create"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.email.routing.address.create"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -23344,7 +25730,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/destination_address_response_single" }
+ }
},
"description": "Delete destination address response"
},
@@ -23365,7 +25753,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete destination address",
"tags": ["Email Routing destination addresses"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.delete"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.email.routing.address.delete"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"get": {
@@ -23388,7 +25778,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/destination_address_response_single" }
+ }
},
"description": "Get a destination address response"
},
@@ -23409,7 +25801,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get a destination address",
"tags": ["Email Routing destination addresses"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.read"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.email.routing.address.read"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -23427,7 +25821,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_collection" }
+ }
+ },
"description": "List IP Access rules response"
},
"4xx": {
@@ -23478,7 +25876,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Create an IP Access rule response"
},
"4xx": {
@@ -23523,7 +25923,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete an IP Access rule response"
},
"4xx": {
@@ -23565,7 +25969,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Get an IP Access rule response"
},
"4xx": {
@@ -23606,12 +26012,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rule" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Update an IP Access rule response"
},
"4xx": {
@@ -23644,13 +26054,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/image_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/image_response_collection" }
+ }
},
"description": "List images response"
},
@@ -23680,18 +26094,26 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
"content": {
- "multipart/form-data": { "schema": { "$ref": "#/components/schemas/image_basic_upload_via_url" } }
+ "multipart/form-data": {
+ "schema": { "$ref": "#/components/schemas/image_basic_upload_via_url" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/image_response_single" }
+ }
+ },
"description": "Upload an image via URL response"
},
"4xx": {
@@ -23723,19 +26145,25 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-direct_upload_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-direct_upload_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-direct_upload_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-direct_upload_response" }
+ }
},
"description": "Create authenticated direct upload URL response"
},
@@ -23756,7 +26184,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create authenticated direct upload URL",
"tags": ["Cloudflare Images"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/images/x-cfDeprecations/direct_upload_v1_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/images/x-cfDeprecations/direct_upload_v1_deprecation"
+ }
}
},
"/accounts/{account_identifier}/images/v1/keys": {
@@ -23774,7 +26204,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-key_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-key_response_collection" }
+ }
},
"description": "List Signing Keys response"
},
@@ -23806,12 +26238,16 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/images_stats" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/images_stats" } }
+ },
"description": "Images usage statistics response"
},
"4xx": {
@@ -23847,7 +26283,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_list_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_list_response" }
+ }
+ },
"description": "List variants response"
},
"4xx": {
@@ -23881,13 +26321,19 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/variant_generation_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_generation_request" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_simple_response" }
+ }
+ },
"description": "Create a variant response"
},
"4xx": {
@@ -23931,7 +26377,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-deleted_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-deleted_response" }
+ }
},
"description": "Delete a variant response"
},
@@ -23972,7 +26420,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_simple_response" }
+ }
+ },
"description": "Variant details response"
},
"4xx": {
@@ -24011,12 +26463,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_patch_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_patch_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/variant_simple_response" }
+ }
+ },
"description": "Update a variant response"
},
"4xx": {
@@ -24053,14 +26513,18 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-deleted_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-deleted_response" }
+ }
},
"description": "Delete image response"
},
@@ -24096,12 +26560,18 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/image_response_single" }
+ }
+ },
"description": "Image details response"
},
"4xx": {
@@ -24136,16 +26606,24 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_patch_request" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/image_patch_request" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/image_response_single" }
+ }
+ },
"description": "Update image response"
},
"4xx": {
@@ -24182,12 +26660,18 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_blob" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/image_response_blob" }
+ }
+ },
"description": "Base image response"
},
"4xx": {
@@ -24218,19 +26702,25 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/images_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/images_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
"content": {
- "multipart/form-data": { "schema": { "$ref": "#/components/schemas/direct_upload_request_v2" } }
+ "multipart/form-data": {
+ "schema": { "$ref": "#/components/schemas/direct_upload_request_v2" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_response_v2" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/direct_upload_response_v2" }
+ }
},
"description": "Create authenticated direct upload URL V2 response"
},
@@ -24268,7 +26758,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/phishing_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/phishing_components-schemas-single_response"
+ }
}
},
"description": "Scan suspicious url response"
@@ -24312,7 +26804,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/asn_components-schemas-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/asn_components-schemas-response" }
+ }
},
"description": "Get ASN Overview response"
},
@@ -24423,7 +26917,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response"
+ }
}
},
"description": "Get Passive DNS by IP response"
@@ -24433,7 +26929,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -24462,7 +26960,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/domain_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/domain_components-schemas-single_response"
+ }
}
},
"description": "Get Domain Details response"
@@ -24499,7 +26999,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response" } }
+ },
"description": "Get Domain History response"
},
"4xx": {
@@ -24535,7 +27037,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-collection_response" }
+ }
},
"description": "Get Multiple Domain Details response"
},
@@ -24571,7 +27075,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response" } }
+ },
"description": "Get IP Overview response"
},
"4xx": {
@@ -24607,7 +27113,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-response" }
+ }
},
"description": "Get IP Lists response"
},
@@ -24642,12 +27150,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/miscategorization" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/miscategorization" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Create Miscategorization response"
},
"4xx": {
@@ -24684,7 +27198,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/whois_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/whois_components-schemas-single_response"
+ }
}
},
"description": "Get WHOIS Record response"
@@ -24724,7 +27240,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-response_collection-2" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-response_collection-2"
+ }
}
},
"description": "List Monitors response"
@@ -24734,7 +27252,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/monitor_components-schemas-response_collection-2" },
+ {
+ "$ref": "#/components/schemas/monitor_components-schemas-response_collection-2"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -24766,7 +27286,9 @@
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
"consecutive_down": { "$ref": "#/components/schemas/consecutive_down" },
"consecutive_up": { "$ref": "#/components/schemas/consecutive_up" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -24790,7 +27312,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response-2"
+ }
}
},
"description": "Create Monitor response"
@@ -24881,7 +27405,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response-2"
+ }
}
},
"description": "Monitor Details response"
@@ -24929,7 +27455,9 @@
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
"consecutive_down": { "$ref": "#/components/schemas/consecutive_down" },
"consecutive_up": { "$ref": "#/components/schemas/consecutive_up" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -24952,7 +27480,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response-2"
+ }
}
},
"description": "Patch Monitor response"
@@ -25000,7 +27530,9 @@
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
"consecutive_down": { "$ref": "#/components/schemas/consecutive_down" },
"consecutive_up": { "$ref": "#/components/schemas/consecutive_up" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -25024,7 +27556,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response-2"
+ }
}
},
"description": "Update Monitor response"
@@ -25092,7 +27626,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } }
+ },
"description": "Preview Monitor response"
},
"4xx": {
@@ -25134,7 +27670,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/references_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/references_response" }
+ }
+ },
"description": "List Monitor References response"
},
"4xx": {
@@ -25172,7 +27712,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/pool_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/pool_components-schemas-response_collection"
+ }
}
},
"description": "List Pools response"
@@ -25211,7 +27753,9 @@
"application/json": {
"schema": {
"properties": {
- "notification_email": { "$ref": "#/components/schemas/patch_pools_notification_email" }
+ "notification_email": {
+ "$ref": "#/components/schemas/patch_pools_notification_email"
+ }
}
}
}
@@ -25222,7 +27766,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/pool_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/pool_components-schemas-response_collection"
+ }
}
},
"description": "Patch Pools response"
@@ -25261,7 +27807,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
"load_shedding": { "$ref": "#/components/schemas/load_shedding" },
@@ -25330,7 +27878,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pool_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pool_components-schemas-id_response" }
+ }
},
"description": "Delete Pool response"
},
@@ -25419,7 +27969,9 @@
"schema": {
"properties": {
"check_regions": { "$ref": "#/components/schemas/check_regions" },
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
@@ -25488,7 +28040,9 @@
"schema": {
"properties": {
"check_regions": { "$ref": "#/components/schemas/check_regions" },
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
@@ -25556,7 +28110,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } }
+ },
"description": "Pool Health Details response"
},
"4xx": {
@@ -25622,7 +28178,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } }
+ },
"description": "Preview Pool response"
},
"4xx": {
@@ -25665,7 +28223,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-references_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-references_response" }
+ }
},
"description": "List Pool References response"
},
@@ -25708,7 +28268,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_result_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/preview_result_response" }
+ }
+ },
"description": "Preview Result response"
},
"4xx": {
@@ -25746,7 +28310,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/region_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/region_components-schemas-response_collection"
+ }
}
},
"description": "List Regions response"
@@ -25756,7 +28322,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/region_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/region_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -25792,7 +28360,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/region_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/region_components-schemas-single_response"
+ }
}
},
"description": "Get Region response"
@@ -25882,7 +28452,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-tunnels_collection_response" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-tunnels_collection_response"
+ }
}
},
"description": "List interconnects response"
@@ -25892,7 +28464,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-tunnels_collection_response" },
+ {
+ "$ref": "#/components/schemas/components-schemas-tunnels_collection_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -25904,7 +28478,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List interconnects",
"tags": ["Magic Interconnects"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -25917,12 +28496,17 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response"
+ }
}
},
"description": "Update multiple interconnects response"
@@ -25932,7 +28516,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response" },
+ {
+ "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -25944,7 +28530,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update multiple interconnects",
"tags": ["Magic Interconnects"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}": {
@@ -25969,7 +28560,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-tunnel_single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-tunnel_single_response"
+ }
}
},
"description": "List interconnect Details response"
@@ -25991,7 +28584,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List interconnect Details",
"tags": ["Magic Interconnects"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26022,7 +28620,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-tunnel_modified_response" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-tunnel_modified_response"
+ }
}
},
"description": "Update interconnect response"
@@ -26044,7 +28644,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update interconnect",
"tags": ["Magic Interconnects"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/gre_tunnels": {
@@ -26062,7 +28667,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/tunnels_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnels_collection_response" }
+ }
},
"description": "List GRE tunnels response"
},
@@ -26083,7 +28690,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List GRE tunnels",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26100,7 +28712,12 @@
"content": {
"application/json": {
"schema": {
- "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"]
+ "required": [
+ "name",
+ "customer_gre_endpoint",
+ "cloudflare_gre_endpoint",
+ "interface_address"
+ ]
}
}
},
@@ -26109,7 +28726,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/tunnels_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnels_collection_response" }
+ }
},
"description": "Create GRE tunnels response"
},
@@ -26130,7 +28749,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create GRE tunnels",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26143,11 +28767,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/modified_tunnels_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/modified_tunnels_collection_response" }
+ }
},
"description": "Update multiple GRE tunnels response"
},
@@ -26168,7 +28797,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update multiple GRE tunnels",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}": {
@@ -26192,7 +28826,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_deleted_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_deleted_response" }
+ }
+ },
"description": "Delete GRE Tunnel response"
},
"4xx": {
@@ -26212,7 +28850,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete GRE Tunnel",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Lists informtion for a specific GRE tunnel.",
@@ -26233,7 +28876,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_single_response" }
+ }
+ },
"description": "List GRE Tunnel Details response"
},
"4xx": {
@@ -26253,7 +28900,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List GRE Tunnel Details",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26273,13 +28925,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_update_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_update_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_modified_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_modified_response" }
+ }
},
"description": "Update GRE Tunnel response"
},
@@ -26300,7 +28958,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update GRE Tunnel",
"tags": ["Magic GRE tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/ipsec_tunnels": {
@@ -26318,7 +28981,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" }
+ }
},
"description": "List IPsec tunnels response"
},
@@ -26339,7 +29004,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List IPsec tunnels",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26356,7 +29026,12 @@
"content": {
"application/json": {
"schema": {
- "required": ["name", "customer_ipsec_endpoint", "cloudflare_ipsec_endpoint", "interface_address"]
+ "required": [
+ "name",
+ "customer_ipsec_endpoint",
+ "cloudflare_ipsec_endpoint",
+ "interface_address"
+ ]
}
}
},
@@ -26365,7 +29040,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" }
+ }
},
"description": "Create IPsec tunnels response"
},
@@ -26386,7 +29063,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create IPsec tunnels",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26399,12 +29081,17 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/schemas-modified_tunnels_collection_response" }
+ "schema": {
+ "$ref": "#/components/schemas/schemas-modified_tunnels_collection_response"
+ }
}
},
"description": "Update multiple IPsec tunnels response"
@@ -26426,7 +29113,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update multiple IPsec tunnels",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}": {
@@ -26451,7 +29143,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_deleted_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_deleted_response" }
+ }
},
"description": "Delete IPsec Tunnel response"
},
@@ -26472,7 +29166,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete IPsec Tunnel",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Lists details for a specific IPsec tunnel.",
@@ -26494,7 +29193,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_single_response" }
+ }
},
"description": "List IPsec tunnel details response"
},
@@ -26515,7 +29216,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List IPsec tunnel details",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.",
@@ -26536,14 +29242,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_update_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_update_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_modified_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-tunnel_modified_response" }
+ }
},
"description": "Update IPsec Tunnel response"
},
@@ -26564,7 +29274,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update IPsec Tunnel",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate": {
@@ -26588,7 +29303,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/psk_generation_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/psk_generation_response" }
+ }
+ },
"description": "Generate Pre Shared Key (PSK) for IPsec tunnels response"
},
"4xx": {
@@ -26608,7 +29327,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Generate Pre Shared Key (PSK) for IPsec tunnels",
"tags": ["Magic IPsec tunnels"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/routes": {
@@ -26626,7 +29350,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/routes_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/routes_collection_response" }
+ }
},
"description": "List Routes response"
},
@@ -26647,7 +29373,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Routes",
"tags": ["Magic Static Routes"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.",
@@ -26661,13 +29392,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["prefix", "nexthop", "priority"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["prefix", "nexthop", "priority"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/routes_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/routes_collection_response" }
+ }
},
"description": "Create Routes response"
},
@@ -26689,7 +29424,12 @@
"summary": "Create Routes",
"tags": ["Magic Static Routes"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.",
@@ -26703,13 +29443,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_update_many_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_update_many_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/multiple_route_modified_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/multiple_route_modified_response" }
+ }
},
"description": "Update Many Routes response"
},
@@ -26731,7 +29477,12 @@
"summary": "Update Many Routes",
"tags": ["Magic Static Routes"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/magic/routes/{route_identifier}": {
@@ -26755,7 +29506,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_deleted_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_deleted_response" }
+ }
+ },
"description": "Delete Route response"
},
"4xx": {
@@ -26776,7 +29531,12 @@
"summary": "Delete Route",
"tags": ["Magic Static Routes"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get a specific Magic static route.",
@@ -26797,7 +29557,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_single_response" }
+ }
+ },
"description": "Route Details response"
},
"4xx": {
@@ -26818,7 +29582,12 @@
"summary": "Route Details",
"tags": ["Magic Static Routes"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.",
@@ -26838,12 +29607,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_update_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_update_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_modified_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_modified_response" }
+ }
+ },
"description": "Update Route response"
},
"4xx": {
@@ -26864,7 +29641,12 @@
"summary": "Update Route",
"tags": ["Magic Static Routes"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/members": {
@@ -26881,7 +29663,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_collection" }
+ }
+ },
"description": "List Members response"
},
"4xx": {
@@ -26916,12 +29702,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Add Member response"
},
"4xx": {
@@ -26966,7 +29756,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Remove Member response"
},
"4xx": {
@@ -27008,7 +29802,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Member Details response"
},
"4xx": {
@@ -27049,12 +29845,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-member" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-member" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Update Member response"
},
"4xx": {
@@ -27087,13 +29887,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "Delete account configuration response"
},
"4xx": {
@@ -27122,12 +29926,16 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "List account configuration response"
},
"4xx": {
@@ -27156,13 +29964,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "Update account configuration fields response"
},
"4xx": {
@@ -27191,13 +30003,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "Create account configuration response"
},
"4xx": {
@@ -27226,13 +30042,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "Update an entire account configuration response"
},
"4xx": {
@@ -27263,12 +30083,16 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/config_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config" } }
+ },
"description": "List rules and account configuration response"
},
"4xx": {
@@ -27304,7 +30128,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } }
+ },
"description": "List rules response"
},
"4xx": {
@@ -27339,7 +30165,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } }
+ },
"description": "Create rules response"
},
"4xx": {
@@ -27374,7 +30202,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules" } }
+ },
"description": "Update rules response"
},
"4xx": {
@@ -27417,7 +30247,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } }
+ },
"description": "Delete rule response"
},
"4xx": {
@@ -27457,7 +30289,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } }
+ },
"description": "Get rule response"
},
"4xx": {
@@ -27498,7 +30332,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule" } }
+ },
"description": "Update rule response"
},
"4xx": {
@@ -27542,7 +30378,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rule_automatic_advertisement" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/mnm_rule_automatic_advertisement" }
+ }
},
"description": "Update advertisement for rule response"
},
@@ -27579,7 +30417,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } }
+ },
"description": "Get projects response"
},
"4xx": {
@@ -27612,12 +30452,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/projects" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new-project-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/new-project-response" }
+ }
+ },
"description": "Create project response"
},
"4xx": {
@@ -27662,7 +30508,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } }
+ "schema": {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ }
}
},
"description": "Delete project response"
@@ -27672,7 +30520,9 @@
"application/json": {
"schema": {
"allOf": [
- { "example": { "errors": [], "messages": [], "result": null, "success": true } },
+ {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -27704,7 +30554,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/project-response" } }
+ },
"description": "Get project response"
},
"4xx": {
@@ -27743,12 +30595,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-patch" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/project-patch" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new-project-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/new-project-response" }
+ }
+ },
"description": "Update project response"
},
"4xx": {
@@ -27791,7 +30649,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-list-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-list-response" }
+ }
},
"description": "Get deployments response"
},
@@ -27834,7 +30694,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-new-deployment" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-new-deployment" }
+ }
},
"description": "Create deployment response"
},
@@ -27886,7 +30748,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } }
+ "schema": {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ }
}
},
"description": "Delete deployment response"
@@ -27896,7 +30760,9 @@
"application/json": {
"schema": {
"allOf": [
- { "example": { "errors": [], "messages": [], "result": null, "success": true } },
+ {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -27935,7 +30801,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-details" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-response-details" }
+ }
},
"description": "Get deployment info response"
},
@@ -27985,7 +30853,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-logs" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-response-logs" }
+ }
},
"description": "Get deployment logs response"
},
@@ -28042,7 +30912,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-stage-logs" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-response-stage-logs" }
+ }
},
"description": "Get deployment stage logs response"
},
@@ -28063,7 +30935,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get deployment stage logs",
"tags": ["Pages Deployment"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/deployments/x-cfDeprecations/logs_v1_deprecated" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/deployments/x-cfDeprecations/logs_v1_deprecated"
+ }
}
},
"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry": {
@@ -28094,7 +30968,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-new-deployment" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-new-deployment" }
+ }
},
"description": "Retry deployment response"
},
@@ -28145,7 +31021,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-details" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/deployment-response-details" }
+ }
},
"description": "Rollback deployment response"
},
@@ -28189,7 +31067,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain-response-collection" }
+ }
},
"description": "Get domains response"
},
@@ -28229,12 +31109,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domains-post" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/domains-post" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain-response-single" }
+ }
+ },
"description": "Add domain response"
},
"4xx": {
@@ -28285,7 +31171,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } }
+ "schema": {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ }
}
},
"description": "Delete domain response"
@@ -28295,7 +31183,9 @@
"application/json": {
"schema": {
"allOf": [
- { "example": { "errors": [], "messages": [], "result": null, "success": true } },
+ {
+ "example": { "errors": [], "messages": [], "result": null, "success": true }
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -28333,7 +31223,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain-response-single" }
+ }
+ },
"description": "Get domain response"
},
"4xx": {
@@ -28380,7 +31274,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain-response-single" }
+ }
+ },
"description": "Patch domain response"
},
"4xx": {
@@ -28417,7 +31315,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_collection_response" }
+ }
},
"description": "List packet capture requests response"
},
@@ -28438,7 +31338,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List packet capture requests",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create new PCAP request for account.",
@@ -28452,12 +31357,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_request_pcap" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_request_pcap" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_single_response" }
+ }
+ },
"description": "Create PCAP request response"
},
"4xx": {
@@ -28477,7 +31388,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create PCAP request",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/pcaps/ownership": {
@@ -28495,7 +31411,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_ownership_collection" }
+ }
},
"description": "List PCAPs Bucket Ownership response"
},
@@ -28516,7 +31434,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List PCAPs Bucket Ownership",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Adds an AWS or GCP bucket to use with full packet captures.",
@@ -28530,13 +31453,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_ownership_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" }
+ }
},
"description": "Add buckets for full packet captures response"
},
@@ -28557,7 +31486,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Add buckets for full packet captures",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/pcaps/ownership/validate": {
@@ -28574,14 +31508,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_validate_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_ownership_validate_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" }
+ }
},
"description": "Validate buckets for full packet captures response"
},
@@ -28602,7 +31540,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Validate buckets for full packet captures",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/pcaps/ownership/{identifier}": {
@@ -28637,7 +31580,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete buckets for full packet captures",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/pcaps/{identifier}": {
@@ -28660,7 +31608,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pcaps_single_response" }
+ }
+ },
"description": "Get PCAP request response"
},
"4xx": {
@@ -28680,7 +31632,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get PCAP request",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/pcaps/{identifier}/download": {
@@ -28702,13 +31659,24 @@
}
],
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Download Simple PCAP response" },
- "4xx": { "content": { "application/json": {} }, "description": "Download Simple PCAP response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Download Simple PCAP response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Download Simple PCAP response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Download Simple PCAP",
"tags": ["Magic PCAP collection"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/r2/buckets": {
@@ -28724,13 +31692,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": "{'name': 'example-bucket'}" } } },
+ "content": {
+ "application/json": { "schema": { "example": "{'name': 'example-bucket'}" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" }
+ }
},
"description": "Create Bucket response"
},
@@ -28776,7 +31748,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" }
+ }
},
"description": "Delete Bucket response"
},
@@ -28815,7 +31789,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_collection" }
+ }
},
"description": "List Railguns response"
},
@@ -28837,7 +31813,12 @@
"summary": "List Railguns",
"tags": ["Account Railguns"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"operationId": "account-railguns-create-railgun",
@@ -28853,7 +31834,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } },
+ "properties": {
+ "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" }
+ },
"required": ["name"],
"type": "object"
}
@@ -28863,7 +31846,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Create Railgun response"
},
"4xx": {
@@ -28883,7 +31870,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Railgun",
"tags": ["Account Railguns"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/railguns/{identifier}": {
@@ -28908,7 +31900,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single_id" }
+ }
},
"description": "Delete a Railgun response"
},
@@ -28930,7 +31924,12 @@
"summary": "Delete a Railgun",
"tags": ["Account Railguns"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"operationId": "account-railguns-railgun-details",
@@ -28950,7 +31949,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Railgun details response"
},
"4xx": {
@@ -28971,7 +31974,12 @@
"summary": "Railgun details",
"tags": ["Account Railguns"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update a Railgun.",
@@ -28991,12 +31999,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-railgun" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-railgun" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Update Railgun response"
},
"4xx": {
@@ -29017,7 +32031,12 @@
"summary": "Update Railgun",
"tags": ["Account Railguns"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections": {
@@ -29041,7 +32060,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/connection_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_collection_response" }
+ }
},
"description": "List Connections response"
},
@@ -29063,7 +32084,12 @@
"summary": "List Connections",
"tags": ["Railgun Connections"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Associates a zone to the Railgun.",
@@ -29083,13 +32109,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_single_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_single_response" }
+ }
},
"description": "Create connection response"
},
@@ -29111,7 +32143,12 @@
"summary": "Create connection",
"tags": ["Railgun Connections"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}": {
@@ -29142,7 +32179,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_single_id_response" }
+ }
},
"description": "Delete connection response"
},
@@ -29164,7 +32203,12 @@
"summary": "Delete connection",
"tags": ["Railgun Connections"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get a connection by ID.",
@@ -29192,7 +32236,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_single_response" }
+ }
},
"description": "Connection details response"
},
@@ -29214,7 +32260,12 @@
"summary": "Connection details",
"tags": ["Railgun Connections"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Enable or disable a connection.",
@@ -29240,13 +32291,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-connection" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-connection" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/connection_single_response" }
+ }
},
"description": "Update connection response"
},
@@ -29268,7 +32323,12 @@
"summary": "Update connection",
"tags": ["Railgun Connections"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/registrar/domains": {
@@ -29286,7 +32346,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "properties": { "id": { "$ref": "#/components/schemas/domain_names" } }, "required": ["id"] }
+ "schema": {
+ "properties": { "id": { "$ref": "#/components/schemas/domain_names" } },
+ "required": ["id"]
+ }
}
},
"required": true
@@ -29294,7 +32357,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain_response_collection" }
+ }
},
"description": "List domains response"
},
@@ -29337,7 +32402,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain_response_single" }
+ }
+ },
"description": "Get domain response"
},
"4xx": {
@@ -29377,13 +32446,19 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "allOf": [{ "$ref": "#/components/schemas/domain_update_properties" }] } }
+ "application/json": {
+ "schema": { "allOf": [{ "$ref": "#/components/schemas/domain_update_properties" }] }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/domain_response_single" }
+ }
+ },
"description": "Update domain response"
},
"4xx": {
@@ -29419,7 +32494,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_collection" }
+ }
+ },
"description": "List Roles response"
},
"4xx": {
@@ -29462,7 +32541,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Role Details response"
},
"4xx": {
@@ -29500,7 +32581,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/lists-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/lists-response-collection" }
+ }
},
"description": "Get lists response"
},
@@ -29539,7 +32622,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/lists_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/lists_components-schemas-description"
+ },
"kind": { "$ref": "#/components/schemas/kind" },
"name": { "$ref": "#/components/schemas/lists_components-schemas-name" }
},
@@ -29553,7 +32638,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-response-collection" }
+ }
},
"description": "Create a list response"
},
@@ -29598,7 +32685,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/bulk-operation-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/bulk-operation-response-collection" }
+ }
},
"description": "Get bulk operation status response"
},
@@ -29627,7 +32716,12 @@
"description": "Deletes a specific list and all its items.",
"operationId": "lists-delete-a-list",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29639,7 +32733,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-delete-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-delete-response-collection" }
+ }
},
"description": "Delete a list response"
},
@@ -29666,7 +32762,12 @@
"description": "Fetches the details of a list.",
"operationId": "lists-get-a-list",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29677,7 +32778,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-response-collection" }
+ }
},
"description": "Get a list response"
},
@@ -29704,7 +32807,12 @@
"description": "Updates the description of a list.",
"operationId": "lists-update-a-list",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29717,7 +32825,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/lists_components-schemas-description" }
+ "description": {
+ "$ref": "#/components/schemas/lists_components-schemas-description"
+ }
},
"type": "object"
}
@@ -29728,7 +32838,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-response-collection" }
+ }
},
"description": "Update a list response"
},
@@ -29757,7 +32869,12 @@
"description": "Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.",
"operationId": "lists-delete-list-items",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29784,7 +32901,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/lists-async-response" }
+ }
+ },
"description": "Delete list items response"
},
"4xx": {
@@ -29810,7 +32931,12 @@
"description": "Fetches all the items in the list.",
"operationId": "lists-get-list-items",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29821,7 +32947,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/items-list-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/items-list-response-collection" }
+ }
},
"description": "Get list items response"
},
@@ -29848,7 +32976,12 @@
"description": "Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.",
"operationId": "lists-create-list-items",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29858,13 +32991,19 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/items-update-request-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/items-update-request-collection" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/lists-async-response" }
+ }
+ },
"description": "Create list items response"
},
"4xx": {
@@ -29890,7 +33029,12 @@
"description": "Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.",
"operationId": "lists-update-all-list-items",
"parameters": [
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29900,13 +33044,19 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/items-update-request-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/items-update-request-collection" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/lists-async-response" }
+ }
+ },
"description": "Update all list items response"
},
"4xx": {
@@ -29934,8 +33084,18 @@
"description": "Fetches a list item in the list.",
"operationId": "lists-get-a-list-item",
"parameters": [
- { "in": "path", "name": "item_id", "required": true, "schema": { "$ref": "#/components/schemas/item_id" } },
- { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } },
+ {
+ "in": "path",
+ "name": "item_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/item_id" }
+ },
+ {
+ "in": "path",
+ "name": "list_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/list_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -29946,7 +33106,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/item-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/item-response-collection" }
+ }
},
"description": "Get a list item response"
},
@@ -29986,7 +33148,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/acl_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/acl_components-schemas-response_collection"
+ }
}
},
"description": "List ACLs response"
@@ -30009,7 +33173,12 @@
"summary": "List ACLs",
"tags": ["Secondary DNS (ACL)"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create ACL.",
@@ -30053,7 +33222,12 @@
"summary": "Create ACL",
"tags": ["Secondary DNS (ACL)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/secondary_dns/acls/{identifier}": {
@@ -30078,7 +33252,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/acl_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/acl_components-schemas-id_response" }
+ }
},
"description": "Delete ACL response"
},
@@ -30100,7 +33276,12 @@
"summary": "Delete ACL",
"tags": ["Secondary DNS (ACL)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get ACL.",
@@ -30146,7 +33327,12 @@
"summary": "ACL Details",
"tags": ["Secondary DNS (ACL)"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Modify ACL.",
@@ -30196,7 +33382,12 @@
"summary": "Update ACL",
"tags": ["Secondary DNS (ACL)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/secondary_dns/peers": {
@@ -30215,7 +33406,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/peer_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/peer_components-schemas-response_collection"
+ }
}
},
"description": "List Peers response"
@@ -30238,7 +33431,12 @@
"summary": "List Peers",
"tags": ["Secondary DNS (Peer)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create Peer.",
@@ -30251,7 +33449,10 @@
"schema": { "$ref": "#/components/schemas/schemas-account_identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["name"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["name"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
@@ -30279,7 +33480,12 @@
"summary": "Create Peer",
"tags": ["Secondary DNS (Peer)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/secondary_dns/peers/{identifier}": {
@@ -30304,7 +33510,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/peer_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/peer_components-schemas-id_response" }
+ }
},
"description": "Delete Peer response"
},
@@ -30326,7 +33534,12 @@
"summary": "Delete Peer",
"tags": ["Secondary DNS (Peer)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get Peer.",
@@ -30372,7 +33585,12 @@
"summary": "Peer Details",
"tags": ["Secondary DNS (Peer)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Modify Peer.",
@@ -30422,7 +33640,12 @@
"summary": "Update Peer",
"tags": ["Secondary DNS (Peer)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/secondary_dns/tsigs": {
@@ -30441,7 +33664,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/tsig_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/tsig_components-schemas-response_collection"
+ }
}
},
"description": "List TSIGs response"
@@ -30464,7 +33689,12 @@
"summary": "List TSIGs",
"tags": ["Secondary DNS (TSIG)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create TSIG.",
@@ -30484,7 +33714,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-single_response" }
+ }
},
"description": "Create TSIG response"
},
@@ -30506,7 +33738,12 @@
"summary": "Create TSIG",
"tags": ["Secondary DNS (TSIG)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/secondary_dns/tsigs/{identifier}": {
@@ -30531,7 +33768,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-id_response" }
+ }
},
"description": "Delete TSIG response"
},
@@ -30553,7 +33792,12 @@
"summary": "Delete TSIG",
"tags": ["Secondary DNS (TSIG)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get TSIG.",
@@ -30575,7 +33819,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-single_response" }
+ }
},
"description": "TSIG Details response"
},
@@ -30597,7 +33843,12 @@
"summary": "TSIG Details",
"tags": ["Secondary DNS (TSIG)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Modify TSIG.",
@@ -30623,7 +33874,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-single_response" }
+ }
},
"description": "Update TSIG response"
},
@@ -30645,7 +33898,12 @@
"summary": "Update TSIG",
"tags": ["Secondary DNS (TSIG)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/storage/analytics": {
@@ -30668,7 +33926,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
{
- "properties": { "result": { "$ref": "#/components/schemas/components-schemas-result" } },
+ "properties": {
+ "result": { "$ref": "#/components/schemas/components-schemas-result" }
+ },
"type": "object"
}
]
@@ -30686,7 +33946,9 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
{
- "properties": { "result": { "$ref": "#/components/schemas/components-schemas-result" } },
+ "properties": {
+ "result": { "$ref": "#/components/schemas/components-schemas-result" }
+ },
"type": "object"
}
]
@@ -30724,7 +33986,11 @@
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
{
- "properties": { "result": { "$ref": "#/components/schemas/stored_components-schemas-result" } },
+ "properties": {
+ "result": {
+ "$ref": "#/components/schemas/stored_components-schemas-result"
+ }
+ },
"type": "object"
}
]
@@ -30743,7 +34009,9 @@
{ "$ref": "#/components/schemas/api-response-single" },
{
"properties": {
- "result": { "$ref": "#/components/schemas/stored_components-schemas-result" }
+ "result": {
+ "$ref": "#/components/schemas/stored_components-schemas-result"
+ }
},
"type": "object"
}
@@ -30783,7 +34051,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/namespace" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/namespace" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -30803,7 +34074,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/namespace" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/namespace" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -30835,7 +34109,9 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" }
+ }
},
"required": true
},
@@ -30846,7 +34122,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/namespace" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/namespace" } },
+ "type": "object"
+ }
]
}
}
@@ -30861,7 +34140,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/namespace" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/namespace" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -30899,7 +34181,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Remove a Namespace response"
},
"4xx": {
@@ -30940,13 +34226,19 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Rename a Namespace response"
},
"4xx": {
@@ -30988,12 +34280,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_delete" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/bulk_delete" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Delete multiple key-value pairs response"
},
"4xx": {
@@ -31033,12 +34331,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_write" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/bulk_write" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Write multiple key-value pairs response"
},
"4xx": {
@@ -31088,7 +34392,10 @@
{ "$ref": "#/components/schemas/api-response-common" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/key" }, "type": "array" },
+ "result": {
+ "items": { "$ref": "#/components/schemas/key" },
+ "type": "array"
+ },
"result_info": {
"properties": {
"count": {
@@ -31117,7 +34424,10 @@
{ "$ref": "#/components/schemas/api-response-common" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/key" }, "type": "array" },
+ "result": {
+ "items": { "$ref": "#/components/schemas/key" },
+ "type": "array"
+ },
"result_info": {
"properties": {
"count": {
@@ -31151,7 +34461,12 @@
"description": "Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.",
"operationId": "workers-kv-namespace-read-the-metadata-for-a-key",
"parameters": [
- { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } },
+ {
+ "in": "path",
+ "name": "key_name",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/key_name" }
+ },
{
"in": "path",
"name": "namespace_identifier",
@@ -31187,7 +34502,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/list_metadata" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/list_metadata" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -31209,7 +34528,12 @@
"description": "Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.",
"operationId": "workers-kv-namespace-delete-key-value-pair",
"parameters": [
- { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } },
+ {
+ "in": "path",
+ "name": "key_name",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/key_name" }
+ },
{
"in": "path",
"name": "namespace_identifier",
@@ -31226,7 +34550,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Delete key-value pair response"
},
"4xx": {
@@ -31252,7 +34580,12 @@
"description": "Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the \"Expiration\" response header.",
"operationId": "workers-kv-namespace-read-key-value-pair",
"parameters": [
- { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } },
+ {
+ "in": "path",
+ "name": "key_name",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/key_name" }
+ },
{
"in": "path",
"name": "namespace_identifier",
@@ -31269,7 +34602,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/kv_components-schemas-value" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/kv_components-schemas-value" }
+ }
},
"description": "Read key-value pair response"
},
@@ -31296,7 +34631,12 @@
"description": "Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.",
"operationId": "workers-kv-namespace-write-key-value-pair-with-metadata",
"parameters": [
- { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } },
+ {
+ "in": "path",
+ "name": "key_name",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/key_name" }
+ },
{
"in": "path",
"name": "namespace_identifier",
@@ -31327,7 +34667,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Write key-value pair with metadata response"
},
"4xx": {
@@ -31365,7 +34709,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/video_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/video_response_collection" }
+ }
},
"description": "List videos response"
},
@@ -31418,7 +34764,10 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Initiate video uploads using TUS response" },
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Initiate video uploads using TUS response"
+ },
"4xx": {
"content": { "application/json": {} },
"description": "Initiate video uploads using TUS response failure"
@@ -31442,12 +34791,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/videoClipStandard" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/videoClipStandard" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clipResponseSingle" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/clipResponseSingle" }
+ }
+ },
"description": "Clip videos given a start and end time response"
},
"4xx": {
@@ -31482,12 +34837,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_copy_request" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/video_copy_request" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/video_response_single" }
+ }
+ },
"description": "Upload videos from a URL response"
},
"4xx": {
@@ -31522,12 +34883,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/direct_upload_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/direct_upload_response" }
+ }
+ },
"description": "Upload videos via direct upload URLs response"
},
"4xx": {
@@ -31563,7 +34932,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key_response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/key_response_collection" }
+ }
+ },
"description": "List signing keys response"
},
"4xx": {
@@ -31598,7 +34971,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key_generation_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/key_generation_response" }
+ }
+ },
"description": "Create signing keys response"
},
"4xx": {
@@ -31641,7 +35018,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } }
+ },
"description": "Delete signing keys response"
},
"4xx": {
@@ -31678,7 +35057,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/live_input_response_collection" }
+ }
},
"description": "List live inputs response"
},
@@ -31712,13 +35093,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_input_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_input_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/live_input_response_single" }
+ }
},
"description": "Create a live input response"
},
@@ -31761,8 +35148,14 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete a live input response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete a live input response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete a live input response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete a live input response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete a live input",
@@ -31788,7 +35181,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/live_input_response_single" }
+ }
},
"description": "Retrieve a live input response"
},
@@ -31828,13 +35223,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_input_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_input_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/live_input_response_single" }
+ }
},
"description": "Update a live input response"
},
@@ -31878,7 +35279,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/output_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/output_response_collection" }
+ }
},
"description": "List all outputs associated with a specified live input response"
},
@@ -31918,12 +35321,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_output_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_output_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/output_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/output_response_single" }
+ }
+ },
"description": "Create a new output, connected to a live input response"
},
"4xx": {
@@ -31971,8 +35382,14 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete an output response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete an output response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete an output response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete an output response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete an output",
@@ -32002,12 +35419,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_output_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_output_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/output_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/output_response_single" }
+ }
+ },
"description": "Update an output response"
},
"4xx": {
@@ -32044,7 +35469,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/watermark_response_collection" }
+ }
},
"description": "List watermark profiles response"
},
@@ -32078,13 +35505,19 @@
}
],
"requestBody": {
- "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/watermark_basic_upload" } } },
+ "content": {
+ "multipart/form-data": {
+ "schema": { "$ref": "#/components/schemas/watermark_basic_upload" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/watermark_response_single" }
+ }
},
"description": "Create watermark profiles via basic upload response"
},
@@ -32183,7 +35616,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/watermark_response_single" }
+ }
},
"description": "Watermark profile details response"
},
@@ -32215,13 +35650,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/webhook_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/webhook_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } }
+ },
"description": "Delete webhooks response"
},
"4xx": {
@@ -32250,12 +35689,18 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/webhook_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/webhook_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/webhook_response_single" }
+ }
+ },
"description": "View webhooks response"
},
"4xx": {
@@ -32284,16 +35729,24 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/webhook_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/webhook_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_request" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/webhook_request" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/webhook_response_single" }
+ }
+ },
"description": "Create webhooks response"
},
"4xx": {
@@ -32336,7 +35789,10 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": { "content": { "application/json": {} }, "description": "Delete video response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete video response failure" }
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete video response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete video",
@@ -32361,7 +35817,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/video_response_single" }
+ }
+ },
"description": "Retrieve video details response"
},
"4xx": {
@@ -32406,7 +35866,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/video_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/video_response_collection" }
+ }
},
"description": "Associate videos to NFTs response"
},
@@ -32498,12 +35960,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signed_token_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/signed_token_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signed_token_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/signed_token_response" }
+ }
+ },
"description": "Create signed URL tokens for videso response"
},
"4xx": {
@@ -32546,7 +36016,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/language_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/language_response_collection" }
+ }
},
"description": "List captions or subtitles response"
},
@@ -32574,7 +36046,12 @@
"description": "Removes the captions or subtitles from a video.",
"operationId": "stream-subtitles/-captions-delete-captions-or-subtitles",
"parameters": [
- { "in": "path", "name": "language", "required": true, "schema": { "$ref": "#/components/schemas/language" } },
+ {
+ "in": "path",
+ "name": "language",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/language" }
+ },
{
"in": "path",
"name": "video_identifier",
@@ -32630,7 +36107,12 @@
"description": "Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.",
"operationId": "stream-subtitles/-captions-upload-captions-or-subtitles",
"parameters": [
- { "in": "path", "name": "language", "required": true, "schema": { "$ref": "#/components/schemas/language" } },
+ {
+ "in": "path",
+ "name": "language",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/language" }
+ },
{
"in": "path",
"name": "video_identifier",
@@ -32645,13 +36127,19 @@
}
],
"requestBody": {
- "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/caption_basic_upload" } } },
+ "content": {
+ "multipart/form-data": {
+ "schema": { "$ref": "#/components/schemas/caption_basic_upload" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/language_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/language_response_single" }
+ }
},
"description": "Upload captions or subtitles response"
},
@@ -32694,7 +36182,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/downloads_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/downloads_response" }
+ }
+ },
"description": "List downloads response"
},
"4xx": {
@@ -32735,7 +36227,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/downloads_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/downloads_response" }
+ }
+ },
"description": "Create downloads response"
},
"4xx": {
@@ -32773,7 +36269,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/account_subscription_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/account_subscription_response_collection"
+ }
}
},
"description": "List Subscriptions response"
@@ -32810,13 +36308,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/account_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/account_subscription_response_single" }
+ }
},
"description": "Create Subscription response"
},
@@ -32850,7 +36352,9 @@
"in": "path",
"name": "subscription_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -32928,7 +36432,9 @@
"in": "path",
"name": "subscription_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -32938,13 +36444,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/account_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/account_subscription_response_single" }
+ }
},
"description": "Update Subscription response"
},
@@ -32984,7 +36494,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/route_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_response_collection" }
+ }
},
"description": "List Tunnel Routes response"
},
@@ -33027,7 +36539,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_response_single" }
+ }
+ },
"description": "Get Tunnel Route by IP response"
},
"4xx": {
@@ -33080,7 +36596,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_response_single" }
+ }
+ },
"description": "Delete Route response"
},
"4xx": {
@@ -33126,7 +36646,9 @@
"comment": { "$ref": "#/components/schemas/comment" },
"network": { "description": "New CIDR of this route." },
"tunnel_id": { "description": "UUID of the tunnel this route should belong to." },
- "virtual_network_id": { "description": "UUID of the virtual network to which this route belongs to." }
+ "virtual_network_id": {
+ "description": "UUID of the virtual network to which this route belongs to."
+ }
},
"type": "object"
}
@@ -33136,7 +36658,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_response_single" }
+ }
+ },
"description": "Update Route response"
},
"4xx": {
@@ -33180,7 +36706,9 @@
"schema": {
"properties": {
"comment": { "$ref": "#/components/schemas/comment" },
- "tunnel_id": { "description": "UUID of the tunnel for which this route is being added." },
+ "tunnel_id": {
+ "description": "UUID of the tunnel for which this route is being added."
+ },
"virtual_network_id": {
"description": "optional UUID of the virtual network for which this route is being added; uses the default virtual network of the account if none is provided."
}
@@ -33194,7 +36722,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route_response_single" }
+ }
+ },
"description": "Create Route response"
},
"4xx": {
@@ -33231,7 +36763,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/vnet_response_collection" }
+ }
},
"description": "List Virtual Networks response"
},
@@ -33282,7 +36816,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/vnet_response_single" }
+ }
+ },
"description": "Create Virtual Network response"
},
"4xx": {
@@ -33309,7 +36847,12 @@
"description": "Delete an existing virtual network from the account.",
"operationId": "tunnel-virtual-network-delete-virtual-network",
"parameters": [
- { "in": "path", "name": "vnet_id", "required": true, "schema": { "$ref": "#/components/schemas/vnet_id" } },
+ {
+ "in": "path",
+ "name": "vnet_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/vnet_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -33320,7 +36863,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/vnet_response_single" }
+ }
+ },
"description": "Delete Virtual Network response"
},
"4xx": {
@@ -33345,7 +36892,12 @@
"description": "Update an existing virtual network in the account.",
"operationId": "tunnel-virtual-network-update-virtual-network",
"parameters": [
- { "in": "path", "name": "vnet_id", "required": true, "schema": { "$ref": "#/components/schemas/vnet_id" } },
+ {
+ "in": "path",
+ "name": "vnet_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/vnet_id" }
+ },
{
"in": "path",
"name": "account_identifier",
@@ -33370,7 +36922,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/vnet_response_single" }
+ }
+ },
"description": "Update Virtual Network response"
},
"4xx": {
@@ -33408,7 +36964,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_response_collection" }
+ }
},
"description": "List Argo Tunnels response"
},
@@ -33429,7 +36987,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Argo Tunnels",
"tags": ["Argo Tunnel"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation"
+ }
},
"post": {
"deprecated": true,
@@ -33464,7 +37024,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_response_single" }
+ }
+ },
"description": "Create Argo Tunnel response"
},
"4xx": {
@@ -33484,7 +37048,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Argo Tunnel",
"tags": ["Argo Tunnel"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation"
+ }
}
},
"/accounts/{account_identifier}/tunnels/{tunnel_id}": {
@@ -33506,10 +37072,17 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "type": "object" } } },
+ "required": true
+ },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_response_single" }
+ }
+ },
"description": "Delete Argo Tunnel response"
},
"4xx": {
@@ -33529,7 +37102,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Argo Tunnel",
"tags": ["Argo Tunnel"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation"
+ }
},
"get": {
"deprecated": true,
@@ -33551,7 +37126,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/tunnel_response_single" }
+ }
+ },
"description": "Get Argo Tunnel response"
},
"4xx": {
@@ -33571,7 +37150,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get Argo Tunnel",
"tags": ["Argo Tunnel"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation"
+ }
}
},
"/accounts/{account_identifier}/tunnels/{tunnel_id}/connections": {
@@ -33593,12 +37174,17 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "type": "object" } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/argo-tunnel_components-schemas-empty_response" }
+ "schema": {
+ "$ref": "#/components/schemas/argo-tunnel_components-schemas-empty_response"
+ }
}
},
"description": "Clean Up Argo Tunnel Connections response"
@@ -33608,7 +37194,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/argo-tunnel_components-schemas-empty_response" },
+ {
+ "$ref": "#/components/schemas/argo-tunnel_components-schemas-empty_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -33620,7 +37208,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Clean Up Argo Tunnel Connections",
"tags": ["Argo Tunnel"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/argo-tunnel/x-cfDeprecations/argo_tunnel_deprecation"
+ }
}
},
"/accounts/{account_identifier}/virtual_dns": {
@@ -33638,7 +37228,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/virtual_dns_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/virtual_dns_response_collection" }
+ }
},
"description": "List DNS Firewall Clusters response"
},
@@ -33660,7 +37252,12 @@
"summary": "List DNS Firewall Clusters",
"tags": ["DNS Firewall (Legacy)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create a configured DNS Firewall Cluster.",
@@ -33678,12 +37275,16 @@
"application/json": {
"schema": {
"properties": {
- "deprecate_any_requests": { "$ref": "#/components/schemas/deprecate_any_requests" },
+ "deprecate_any_requests": {
+ "$ref": "#/components/schemas/deprecate_any_requests"
+ },
"ecs_fallback": { "$ref": "#/components/schemas/ecs_fallback" },
"maximum_cache_ttl": { "$ref": "#/components/schemas/maximum_cache_ttl" },
"minimum_cache_ttl": { "$ref": "#/components/schemas/minimum_cache_ttl" },
"name": { "$ref": "#/components/schemas/virtual-dns_components-schemas-name" },
- "negative_cache_ttl": { "$ref": "#/components/schemas/schemas-negative_cache_ttl" },
+ "negative_cache_ttl": {
+ "$ref": "#/components/schemas/schemas-negative_cache_ttl"
+ },
"origin_ips": { "$ref": "#/components/schemas/origin_ips" },
"ratelimit": { "$ref": "#/components/schemas/schemas-ratelimit" }
},
@@ -33696,7 +37297,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" }
+ }
},
"description": "Create DNS Firewall Cluster response"
},
@@ -33718,7 +37321,12 @@
"summary": "Create DNS Firewall Cluster",
"tags": ["DNS Firewall (Legacy)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/virtual_dns/{identifier}": {
@@ -33751,7 +37359,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
}
}
}
@@ -33774,7 +37384,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
}
}
}
@@ -33793,7 +37405,12 @@
"summary": "Delete DNS Firewall Cluster",
"tags": ["DNS Firewall (Legacy)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Show a single configured DNS Firewall cluster for an account.",
@@ -33815,7 +37432,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" }
+ }
},
"description": "DNS Firewall Cluster Details response"
},
@@ -33837,7 +37456,12 @@
"summary": "DNS Firewall Cluster Details",
"tags": ["DNS Firewall (Legacy)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Modify a DNS Firewall Cluster configuration.",
@@ -33857,13 +37481,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-virtual-dns" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-virtual-dns" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/virtual_dns_single_response" }
+ }
},
"description": "Update DNS Firewall Cluster response"
},
@@ -33885,7 +37513,12 @@
"summary": "Update DNS Firewall Cluster",
"tags": ["DNS Firewall (Legacy)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report": {
@@ -33913,7 +37546,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -33928,7 +37564,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -33970,7 +37609,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -33985,7 +37627,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -34017,7 +37662,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/account-settings-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/account-settings-response" }
+ }
},
"description": "Fetch Worker Account Settings response"
},
@@ -34052,13 +37699,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": "{'default_usage_model': 'unbound'}" } } },
+ "content": {
+ "application/json": { "schema": { "example": "{'default_usage_model': 'unbound'}" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/account-settings-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/account-settings-response" }
+ }
},
"description": "Create Worker Account Settings response"
},
@@ -34091,13 +37742,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/domains_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/domains_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-domain-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-domain-response-collection" }
+ }
},
"description": "List Domains response"
},
@@ -34128,7 +37783,9 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/domains_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/domains_components-schemas-account_identifier"
+ }
}
],
"requestBody": {
@@ -34151,7 +37808,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-domain-response-single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-domain-response-single" }
+ }
},
"description": "Attach to Domain response"
},
@@ -34190,13 +37849,21 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/domains_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/domains_components-schemas-account_identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Detach from Domain response" },
- "4xx": { "content": { "application/json": {} }, "description": "Detach from Domain response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Detach from Domain response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Detach from Domain response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Detach from Domain",
@@ -34217,13 +37884,17 @@
"in": "path",
"name": "account_identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/domains_components-schemas-account_identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/domains_components-schemas-account_identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-domain-response-single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-domain-response-single" }
+ }
},
"description": "Get a Domain response"
},
@@ -34268,7 +37939,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-namespace" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-namespace" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -34288,7 +37962,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/schemas-namespace" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/schemas-namespace" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -34305,7 +37982,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Namespaces",
"tags": ["Durable Objects Namespace"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.durable-object.class.list"] }
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.edge.worker.durable-object.class.list"]
+ }
}
},
"/accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects": {
@@ -34335,7 +38014,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/object" }, "type": "array" },
+ "result": {
+ "items": { "$ref": "#/components/schemas/object" },
+ "type": "array"
+ },
"result_info": {
"properties": {
"count": {
@@ -34365,7 +38047,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/object" }, "type": "array" },
+ "result": {
+ "items": { "$ref": "#/components/schemas/object" },
+ "type": "array"
+ },
"result_info": {
"properties": {
"count": {
@@ -34392,7 +38077,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Objects",
"tags": ["Durable Objects Namespace"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.durable-object.class.read"] }
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.edge.worker.durable-object.class.read"]
+ }
}
},
"/accounts/{account_identifier}/workers/queues": {
@@ -34432,7 +38119,10 @@
},
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/queue" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/queue" },
+ "type": "array"
+ }
},
"required": [
"queue_id",
@@ -34478,7 +38168,10 @@
},
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/queue" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/queue" },
+ "type": "array"
+ }
},
"required": [
"queue_id",
@@ -34519,7 +38212,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": { "queue_name": "example-queue" } } } },
+ "content": {
+ "application/json": { "schema": { "example": { "queue_name": "example-queue" } } }
+ },
"required": true
},
"responses": {
@@ -34531,7 +38226,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue_created" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue_created" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34552,7 +38250,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue_created" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue_created" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34656,7 +38357,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34677,7 +38381,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34715,7 +38422,11 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": { "queue_name": "renamed-example-queue" } } } },
+ "content": {
+ "application/json": {
+ "schema": { "example": { "queue_name": "renamed-example-queue" } }
+ }
+ },
"required": true
},
"responses": {
@@ -34727,7 +38438,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue_updated" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue_updated" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34748,7 +38462,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/queue_updated" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/queue_updated" }],
+ "type": "object"
+ }
},
"required": ["queue_id", "queue_name", "created_on", "modified_on"],
"type": "object"
@@ -34812,7 +38529,10 @@
},
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/consumer" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/consumer" },
+ "type": "array"
+ }
},
"required": ["queue_name", "created_on", "settings"],
"type": "object"
@@ -34849,7 +38569,10 @@
},
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/consumer" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/consumer" },
+ "type": "array"
+ }
},
"required": ["queue_name", "created_on", "settings"],
"type": "object"
@@ -34910,9 +38633,18 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/consumer_created" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/consumer_created" }],
+ "type": "object"
+ }
},
- "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"],
+ "required": [
+ "queue_name",
+ "script_name",
+ "settings",
+ "dead_letter_queue",
+ "created_on"
+ ],
"type": "object"
}
]
@@ -34936,7 +38668,13 @@
"type": "object"
}
},
- "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"],
+ "required": [
+ "queue_name",
+ "script_name",
+ "settings",
+ "dead_letter_queue",
+ "created_on"
+ ],
"type": "object"
}
]
@@ -35065,9 +38803,18 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "allOf": [{ "$ref": "#/components/schemas/consumer_updated" }], "type": "object" }
+ "result": {
+ "allOf": [{ "$ref": "#/components/schemas/consumer_updated" }],
+ "type": "object"
+ }
},
- "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"],
+ "required": [
+ "queue_name",
+ "script_name",
+ "settings",
+ "dead_letter_queue",
+ "created_on"
+ ],
"type": "object"
}
]
@@ -35091,7 +38838,13 @@
"type": "object"
}
},
- "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"],
+ "required": [
+ "queue_name",
+ "script_name",
+ "settings",
+ "dead_letter_queue",
+ "created_on"
+ ],
"type": "object"
}
]
@@ -35125,7 +38878,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/script-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/script-response-collection" }
+ }
},
"description": "List Workers response"
},
@@ -35170,7 +38925,10 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": { "content": { "application/json": {} }, "description": "Delete Worker response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete Worker response failure" }
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete Worker response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Worker",
@@ -35342,7 +39100,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" }
+ }
},
"description": "Get Cron Triggers response"
},
@@ -35383,13 +39143,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": "[{'cron': '*/30 * * * *'}]" } } },
+ "content": {
+ "application/json": { "schema": { "example": "[{'cron': '*/30 * * * *'}]" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" }
+ }
},
"description": "Update Cron Triggers response"
},
@@ -35433,7 +39197,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } }
+ },
"description": "List Tails response"
},
"4xx": {
@@ -35475,7 +39241,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } }
+ },
"description": "Start Tail response"
},
"4xx": {
@@ -35496,7 +39264,10 @@
"summary": "Start Tail",
"tags": ["Worker Tail Logs"],
"x-cfPermissionsRequired": {
- "enum": ["com.cloudflare.edge.worker.script.read", "com.cloudflare.edge.worker.tail.create"]
+ "enum": [
+ "com.cloudflare.edge.worker.script.read",
+ "com.cloudflare.edge.worker.tail.create"
+ ]
}
}
},
@@ -35527,7 +39298,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-common" }
+ }
+ },
"description": "Delete Tail response"
},
"4xx": {
@@ -35548,7 +39323,10 @@
"summary": "Delete Tail",
"tags": ["Worker Tail Logs"],
"x-cfPermissionsRequired": {
- "enum": ["com.cloudflare.edge.worker.script.read", "com.cloudflare.edge.worker.tail.create"]
+ "enum": [
+ "com.cloudflare.edge.worker.script.read",
+ "com.cloudflare.edge.worker.tail.create"
+ ]
}
}
},
@@ -35572,7 +39350,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usage-model-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/usage-model-response" }
+ }
+ },
"description": "Fetch Usage Model response"
},
"4xx": {
@@ -35612,12 +39394,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": "{'usage_model': 'unbound'}" } } },
+ "content": {
+ "application/json": { "schema": { "example": "{'usage_model': 'unbound'}" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usage-model-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/usage-model-response" }
+ }
+ },
"description": "Update Usage Model response"
},
"4xx": {
@@ -35654,7 +39442,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subdomain-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/subdomain-response" }
+ }
+ },
"description": "Get Subdomain response"
},
"4xx": {
@@ -35688,12 +39480,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "example": "{'subdomain': 'example-subdomain'}" } } },
+ "content": {
+ "application/json": { "schema": { "example": "{'subdomain': 'example-subdomain'}" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subdomain-response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/subdomain-response" }
+ }
+ },
"description": "Create Subdomain response"
},
"4xx": {
@@ -35732,7 +39530,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/categories_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/categories_components-schemas-response_collection"
+ }
}
},
"description": "List Categories response"
@@ -35742,7 +39542,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/categories_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/categories_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -35770,7 +39572,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List account rulesets response"
},
"4xx": {
@@ -35804,12 +39608,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Create an account ruleset response"
},
"4xx": {
@@ -35852,7 +39660,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get an account entry point ruleset response"
},
"4xx": {
@@ -35892,12 +39702,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update an account entry point ruleset response"
},
"4xx": {
@@ -35940,7 +39754,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List an account entry point ruleset's versions response"
},
"4xx": {
@@ -35989,7 +39805,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get an account entry point ruleset version response"
},
"4xx": {
@@ -36032,8 +39850,14 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete an account ruleset response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete an account ruleset response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete an account ruleset response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete an account ruleset response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete an account ruleset",
@@ -36059,7 +39883,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get an account ruleset response"
},
"4xx": {
@@ -36099,12 +39925,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update an account ruleset response"
},
"4xx": {
@@ -36146,12 +39976,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Create an account ruleset rule response"
},
"4xx": {
@@ -36201,7 +40035,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Delete an account ruleset rule response"
},
"4xx": {
@@ -36247,12 +40083,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update an account ruleset rule response"
},
"4xx": {
@@ -36295,7 +40135,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List an account ruleset's versions response"
},
"4xx": {
@@ -36344,7 +40186,10 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete an account ruleset version response" },
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete an account ruleset version response"
+ },
"4xx": {
"content": { "application/json": {} },
"description": "Delete an account ruleset version response failure"
@@ -36380,7 +40225,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get an account ruleset version response"
},
"4xx": {
@@ -36408,7 +40255,12 @@
"description": "Fetches the rules of a managed account ruleset version for a given tag.",
"operationId": "account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag",
"parameters": [
- { "in": "path", "name": "rule_tag", "required": true, "schema": { "$ref": "#/components/schemas/category" } },
+ {
+ "in": "path",
+ "name": "rule_tag",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/category" }
+ },
{
"in": "path",
"name": "ruleset_version",
@@ -36430,7 +40282,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "List an account ruleset version's rules by tag response"
},
"4xx": {
@@ -36467,7 +40321,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Account Details response"
},
"4xx": {
@@ -36503,13 +40359,17 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-account" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-account" }
+ }
},
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Update Account response"
},
"4xx": {
@@ -36549,7 +40409,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/apps_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/apps_components-schemas-response_collection"
+ }
}
},
"description": "List Access applications response"
@@ -36584,7 +40446,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["name", "type", "domain"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["name", "type", "domain"] } }
+ },
"required": true
},
"responses": {
@@ -36659,7 +40523,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ca_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/ca_components-schemas-response_collection"
+ }
}
},
"description": "List short-lived certificate CAs response"
@@ -36705,7 +40571,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/apps_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/apps_components-schemas-id_response" }
+ }
},
"description": "Delete an Access application response"
},
@@ -36789,7 +40657,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["name", "type", "domain"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["name", "type", "domain"] } }
+ },
"required": true
},
"responses": {
@@ -36870,7 +40740,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" }
+ }
},
"description": "Revoke service tokens response"
},
@@ -36913,7 +40785,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/policy_check_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/policy_check_response" }
+ }
+ },
"description": "Test Access policies response"
},
"4xx": {
@@ -37014,7 +40890,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Get an Access policy response"
@@ -37072,8 +40950,12 @@
"include": { "$ref": "#/components/schemas/include" },
"name": { "$ref": "#/components/schemas/policies_components-schemas-name" },
"precedence": { "$ref": "#/components/schemas/precedence" },
- "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" },
- "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" },
+ "purpose_justification_prompt": {
+ "$ref": "#/components/schemas/purpose_justification_prompt"
+ },
+ "purpose_justification_required": {
+ "$ref": "#/components/schemas/purpose_justification_required"
+ },
"require": { "$ref": "#/components/schemas/schemas-require" }
},
"required": ["name", "decision", "include"]
@@ -37086,7 +40968,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Update an Access policy response"
@@ -37115,7 +40999,12 @@
"description": "Deletes a short-lived certificate CA.",
"operationId": "access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37127,7 +41016,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-id_response" }
+ }
},
"description": "Delete a short-lived certificate CA response"
},
@@ -37153,7 +41044,12 @@
"description": "Fetches a short-lived certificate CA and its public key.",
"operationId": "access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37164,7 +41060,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" }
+ }
},
"description": "Get a short-lived certificate CA response"
},
@@ -37190,7 +41088,12 @@
"description": "Generates a new short-lived certificate CA and public key.",
"operationId": "access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37202,7 +41105,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" }
+ }
},
"description": "Create a short-lived certificate CA response"
},
@@ -37247,7 +41152,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection"
+ }
}
},
"description": "List Access policies response"
@@ -37257,7 +41164,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/policies_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37299,8 +41208,12 @@
"include": { "$ref": "#/components/schemas/include" },
"name": { "$ref": "#/components/schemas/policies_components-schemas-name" },
"precedence": { "$ref": "#/components/schemas/precedence" },
- "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" },
- "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" },
+ "purpose_justification_prompt": {
+ "$ref": "#/components/schemas/purpose_justification_prompt"
+ },
+ "purpose_justification_required": {
+ "$ref": "#/components/schemas/purpose_justification_required"
+ },
"require": { "$ref": "#/components/schemas/schemas-require" }
},
"required": ["name", "decision", "include"]
@@ -37313,7 +41226,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Create an Access policy response"
@@ -37354,7 +41269,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection"
+ }
}
},
"description": "List Bookmark applications response"
@@ -37364,7 +41281,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37376,7 +41295,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Bookmark applications",
"tags": ["Access Bookmark applications (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation"
+ }
}
},
"/accounts/{identifier}/access/bookmarks/{uuid}": {
@@ -37385,7 +41306,12 @@
"description": "Deletes a Bookmark application.",
"operationId": "access-bookmark-applications-(-deprecated)-delete-a-bookmark-application",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37398,7 +41324,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-id_response"
+ }
}
},
"description": "Delete a Bookmark application response"
@@ -37420,14 +41348,21 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete a Bookmark application",
"tags": ["Access Bookmark applications (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation"
+ }
},
"get": {
"deprecated": true,
"description": "Fetches a single Bookmark application.",
"operationId": "access-bookmark-applications-(-deprecated)-get-a-bookmark-application",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37439,7 +41374,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-single_response"
+ }
}
},
"description": "Get a Bookmark application response"
@@ -37461,14 +41398,21 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get a Bookmark application",
"tags": ["Access Bookmark applications (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation"
+ }
},
"post": {
"deprecated": true,
"description": "Create a new Bookmark application.",
"operationId": "access-bookmark-applications-(-deprecated)-create-a-bookmark-application",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37481,7 +41425,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-single_response"
+ }
}
},
"description": "Create a Bookmark application response"
@@ -37503,14 +41449,21 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create a Bookmark application",
"tags": ["Access Bookmark applications (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation"
+ }
},
"put": {
"deprecated": true,
"description": "Updates a configured Bookmark application.",
"operationId": "access-bookmark-applications-(-deprecated)-update-a-bookmark-application",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37523,7 +41476,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/bookmarks_components-schemas-single_response"
+ }
}
},
"description": "Update a Bookmark application response"
@@ -37545,7 +41500,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update a Bookmark application",
"tags": ["Access Bookmark applications (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bookmarks/x-cfDeprecations/bookmarks_deprecation"
+ }
}
},
"/accounts/{identifier}/access/certificates": {
@@ -37564,7 +41521,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-response_collection"
+ }
}
},
"description": "List mTLS certificates response"
@@ -37574,7 +41533,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37621,7 +41582,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Add an mTLS certificate response"
@@ -37631,7 +41594,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37650,7 +41615,12 @@
"description": "Deletes an mTLS certificate.",
"operationId": "access-m-tls-authentication-delete-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37663,7 +41633,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-id_response"
+ }
}
},
"description": "Delete an mTLS certificate response"
@@ -37690,7 +41662,12 @@
"description": "Fetches a single mTLS certificate.",
"operationId": "access-m-tls-authentication-get-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37702,7 +41679,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Get an mTLS certificate response"
@@ -37712,7 +41691,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37729,7 +41710,12 @@
"description": "Updates a configured mTLS certificate.",
"operationId": "access-m-tls-authentication-update-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37755,7 +41741,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Update an mTLS certificate response"
@@ -37765,7 +41753,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37795,7 +41785,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-response_collection"
+ }
}
},
"description": "List Access groups response"
@@ -37805,7 +41797,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/groups_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/groups_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -37849,7 +41843,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Create an Access group response"
@@ -37878,7 +41874,12 @@
"description": "Deletes an Access group.",
"operationId": "access-groups-delete-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37890,7 +41891,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/groups_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/groups_components-schemas-id_response" }
+ }
},
"description": "Delete an Access group response"
},
@@ -37916,7 +41919,12 @@
"description": "Fetches a single Access group.",
"operationId": "access-groups-get-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37928,7 +41936,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Get an Access group response"
@@ -37955,7 +41965,12 @@
"description": "Updates a configured Access group.",
"operationId": "access-groups-update-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -37983,7 +41998,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Update an Access group response"
@@ -38016,14 +42033,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection"
+ }
}
},
"description": "List Access identity providers response"
@@ -38033,7 +42054,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38054,7 +42077,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -38063,8 +42088,12 @@
"schema": {
"properties": {
"config": { "$ref": "#/components/schemas/schemas-config" },
- "name": { "$ref": "#/components/schemas/identity-providers_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/identity-providers_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-type"
+ }
},
"required": ["name", "type", "config"]
}
@@ -38076,7 +42105,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Add an Access identity provider response"
@@ -38086,7 +42117,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38105,12 +42138,19 @@
"description": "Deletes an identity provider from Access.",
"operationId": "access-identity-providers-delete-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -38118,7 +42158,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Delete an Access identity provider response"
@@ -38128,7 +42170,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38145,19 +42189,28 @@
"description": "Fetches a configured identity provider.",
"operationId": "access-identity-providers-get-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Get an Access identity provider response"
@@ -38167,7 +42220,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38184,12 +42239,19 @@
"description": "Updates a configured identity provider.",
"operationId": "access-identity-providers-update-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -38198,8 +42260,12 @@
"schema": {
"properties": {
"config": { "$ref": "#/components/schemas/schemas-config" },
- "name": { "$ref": "#/components/schemas/identity-providers_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/identity-providers_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-type"
+ }
},
"required": ["name", "type", "config"]
}
@@ -38211,7 +42277,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Update an Access identity provider response"
@@ -38221,7 +42289,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38290,7 +42360,9 @@
"application/json": {
"schema": {
"properties": {
- "key_rotation_interval_days": { "$ref": "#/components/schemas/key_rotation_interval_days" }
+ "key_rotation_interval_days": {
+ "$ref": "#/components/schemas/key_rotation_interval_days"
+ }
},
"required": ["key_rotation_interval_days"]
}
@@ -38376,14 +42448,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/access-requests_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/access-requests_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/access-requests_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/access-requests_components-schemas-response_collection"
+ }
}
},
"description": "Get Access authentication logs response"
@@ -38393,7 +42469,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/access-requests_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/access-requests_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38423,7 +42501,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Get your Zero Trust organization response"
@@ -38433,7 +42513,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38477,7 +42559,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Create your Zero Trust organization response"
@@ -38487,7 +42571,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38530,7 +42616,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Update your Zero Trust organization response"
@@ -38540,7 +42628,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38585,7 +42675,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-empty_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-empty_response" }
+ }
+ },
"description": "Revoke all Access tokens for a user response"
},
"4xx": {
@@ -38620,14 +42714,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seats_definition" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/seats_definition" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/seats_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/seats_components-schemas-response_collection"
+ }
}
},
"description": "Update a user seat response"
@@ -38667,7 +42765,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection"
+ }
}
},
"description": "List service tokens response"
@@ -38677,7 +42777,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38705,7 +42807,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } },
+ "properties": {
+ "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }
+ },
"required": ["name"]
}
}
@@ -38714,7 +42818,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } }
+ },
"description": "Create a service token response"
},
"4xx": {
@@ -38741,7 +42847,12 @@
"description": "Deletes a service token.",
"operationId": "access-service-tokens-delete-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -38754,7 +42865,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ }
}
},
"description": "Delete a service token response"
@@ -38764,7 +42877,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38781,7 +42896,12 @@
"description": "Updates a configured service token.",
"operationId": "access-service-tokens-update-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -38793,7 +42913,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } }
+ "properties": {
+ "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }
+ }
}
}
},
@@ -38803,7 +42925,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ }
}
},
"description": "Update a service token response"
@@ -38813,7 +42937,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38832,7 +42958,12 @@
"description": "Refreshes the expiration of a service token.",
"operationId": "access-service-tokens-refresh-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -38845,7 +42976,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ }
}
},
"description": "Refresh a service token response"
@@ -38855,7 +42988,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -38874,7 +43009,12 @@
"description": "Generates a new Client Secret for a service token and revokes the old one.",
"operationId": "access-service-tokens-rotate-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -38885,7 +43025,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } }
+ },
"description": "Rotate a service token response"
},
"4xx": {
@@ -38923,7 +43065,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/users_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/users_components-schemas-response_collection"
+ }
}
},
"description": "Get users response"
@@ -38967,7 +43111,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/failed_login_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/failed_login_response" }
+ }
+ },
"description": "Get failed logins response"
},
"4xx": {
@@ -39005,7 +43153,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/alert-types_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/alert-types_components-schemas-response_collection"
+ }
}
},
"description": "Get Alert Types response"
@@ -39015,7 +43165,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/alert-types_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/alert-types_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39045,7 +43197,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/eligibility_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/eligibility_components-schemas-response_collection"
+ }
}
},
"description": "Get delivery mechanism eligibility response"
@@ -39055,7 +43209,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/eligibility_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/eligibility_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39085,7 +43241,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection"
+ }
}
},
"description": "List PagerDuty services response"
@@ -39095,7 +43253,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39107,7 +43267,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List PagerDuty services",
"tags": ["Notification destinations with PagerDuty"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{identifier}/alerting/v3/destinations/webhooks": {
@@ -39126,7 +43291,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/webhooks_components-schemas-response_collection"
+ }
}
},
"description": "List webhooks response"
@@ -39136,7 +43303,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/webhooks_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/webhooks_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39210,7 +43379,12 @@
"description": "Delete a configured webhook destination.",
"operationId": "notification-webhooks-delete-a-webhook",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39221,7 +43395,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Delete a webhook response"
},
"4xx": {
@@ -39247,7 +43425,12 @@
"description": "Get details for a single webhooks destination.",
"operationId": "notification-webhooks-get-a-webhook",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39259,7 +43442,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/webhooks_components-schemas-single_response"
+ }
}
},
"description": "Get a webhook response"
@@ -39287,7 +43472,12 @@
"description": "Update a webhook destination.",
"operationId": "notification-webhooks-update-a-webhook",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39355,7 +43545,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/history_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/history_components-schemas-response_collection"
+ }
}
},
"description": "List History response"
@@ -39365,7 +43557,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/history_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/history_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39395,7 +43589,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection-2" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection-2"
+ }
}
},
"description": "List Notification policies response"
@@ -39405,7 +43601,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/policies_components-schemas-response_collection-2" },
+ {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection-2"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39435,7 +43633,9 @@
"schema": {
"properties": {
"alert_type": { "$ref": "#/components/schemas/alert_type" },
- "description": { "$ref": "#/components/schemas/policies_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/policies_components-schemas-description"
+ },
"enabled": { "$ref": "#/components/schemas/policies_components-schemas-enabled" },
"filters": { "$ref": "#/components/schemas/components-schemas-filters" },
"mechanisms": { "$ref": "#/components/schemas/mechanisms" },
@@ -39451,7 +43651,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-id_response-2"
+ }
}
},
"description": "Create a Notification policy response"
@@ -39480,7 +43682,12 @@
"description": "Delete a Notification policy.",
"operationId": "notification-policies-delete-a-notification-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39491,7 +43698,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-collection" }
+ }
+ },
"description": "Delete a Notification policy response"
},
"4xx": {
@@ -39516,7 +43727,12 @@
"description": "Get details for a single policy.",
"operationId": "notification-policies-get-a-notification-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39528,7 +43744,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response-2"
+ }
}
},
"description": "Get a Notification policy response"
@@ -39538,7 +43756,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/policies_components-schemas-single_response-2" },
+ {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response-2"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -39555,7 +43775,12 @@
"description": "Update a Notification policy.",
"operationId": "notification-policies-update-a-notification-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39569,7 +43794,9 @@
"schema": {
"properties": {
"alert_type": { "$ref": "#/components/schemas/alert_type" },
- "description": { "$ref": "#/components/schemas/policies_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/policies_components-schemas-description"
+ },
"enabled": { "$ref": "#/components/schemas/policies_components-schemas-enabled" },
"filters": { "$ref": "#/components/schemas/components-schemas-filters" },
"mechanisms": { "$ref": "#/components/schemas/mechanisms" },
@@ -39584,7 +43811,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-id_response-2"
+ }
}
},
"description": "Update a Notification policy response"
@@ -39623,7 +43852,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/acns_response_collection" }
+ }
},
"description": "List Account Custom Nameservers response"
},
@@ -39645,7 +43876,12 @@
"summary": "List Account Custom Nameservers",
"tags": ["Account-Level Custom Nameservers"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"operationId": "account-level-custom-nameservers-add-account-custom-nameserver",
@@ -39658,12 +43894,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomNSInput" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/CustomNSInput" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/acns_response_single" }
+ }
+ },
"description": "Add Account Custom Nameserver response"
},
"4xx": {
@@ -39684,7 +43926,12 @@
"summary": "Add Account Custom Nameserver",
"tags": ["Account-Level Custom Nameservers"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{identifier}/custom_ns/availability": {
@@ -39700,7 +43947,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/availability_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/availability_response" }
+ }
+ },
"description": "Get Eligible Zones for Account Custom Nameservers response"
},
"4xx": {
@@ -39721,7 +43972,12 @@
"summary": "Get Eligible Zones for Account Custom Nameservers",
"tags": ["Account-Level Custom Nameservers"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{identifier}/custom_ns/verify": {
@@ -39739,7 +43995,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/acns_response_collection" }
+ }
},
"description": "Verify Account Custom Nameserver Glue Records response"
},
@@ -39761,14 +44019,24 @@
"summary": "Verify Account Custom Nameserver Glue Records",
"tags": ["Account-Level Custom Nameservers"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{identifier}/custom_ns/{ns_name}": {
"delete": {
"operationId": "account-level-custom-nameservers-delete-account-custom-nameserver",
"parameters": [
- { "in": "path", "name": "ns_name", "required": true, "schema": { "$ref": "#/components/schemas/ns_name" } },
+ {
+ "in": "path",
+ "name": "ns_name",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/ns_name" }
+ },
{
"in": "path",
"name": "identifier",
@@ -39779,7 +44047,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } }
+ },
"description": "Delete Account Custom Nameserver response"
},
"4xx": {
@@ -39800,7 +44070,12 @@
"summary": "Delete Account Custom Nameserver",
"tags": ["Account-Level Custom Nameservers"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/accounts/{identifier}/devices": {
@@ -39817,7 +44092,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/devices_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/devices_response" } }
+ },
"description": "List Devices response"
},
"4xx": {
@@ -39854,7 +44131,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/device_settings_response_collection" }
+ }
},
"description": "List Device Settings Policies response"
},
@@ -39892,7 +44171,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/default_device_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/default_device_settings_response" }
+ }
},
"description": "Get Default Device Settings Policy response"
},
@@ -39948,7 +44229,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/default_device_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/default_device_settings_response" }
+ }
},
"description": "Update Default Device Settings Policy response"
},
@@ -40018,7 +44301,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/device_settings_response" }
+ }
},
"description": "Create Device Settings Policy response"
},
@@ -40056,7 +44341,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" }
+ }
},
"description": "Get Split Tunnel Exclude List response"
},
@@ -40092,7 +44379,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/split_tunnel" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40100,7 +44390,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" }
+ }
},
"description": "Set Split Tunnel Exclude List response"
},
@@ -40138,7 +44430,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" }
+ }
},
"description": "Get Local Domain Fallback List response"
},
@@ -40174,7 +44468,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/fallback_domain" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40182,7 +44479,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" }
+ }
},
"description": "Set Local Domain Fallback List response"
},
@@ -40221,7 +44520,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/split_tunnel_include_response_collection"
+ }
}
},
"description": "Get Split Tunnel Include List response"
@@ -40258,7 +44559,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/split_tunnel_include" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40267,7 +44571,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/split_tunnel_include_response_collection"
+ }
}
},
"description": "Set Split Tunnel Include List response"
@@ -40296,7 +44602,12 @@
"description": "Delete a device settings policy. Returns the remaining policies for the account.",
"operationId": "devices-delete-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40308,7 +44619,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/device_settings_response_collection" }
+ }
},
"description": "Delete Device Settings Policy response"
},
@@ -40334,7 +44647,12 @@
"description": "Get the device settings policy by ID.",
"operationId": "devices-get-device-settings-policy-by-id",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40345,7 +44663,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/device_settings_response" }
+ }
},
"description": "Get Device Settings Policy by ID response"
},
@@ -40371,7 +44691,12 @@
"description": "Update a device settings policy.",
"operationId": "devices-update-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40415,7 +44740,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/device_settings_response" }
+ }
},
"description": "Update Device Settings Policy response"
},
@@ -40443,7 +44770,12 @@
"description": "Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy.",
"operationId": "devices-get-split-tunnel-exclude-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40454,7 +44786,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" }
+ }
},
"description": "Get Split Tunnel Exclude List for a Device Settings Policy response"
},
@@ -40480,7 +44814,12 @@
"description": "Set the list of routes excluded from the WARP client's tunnel for one specific device settings policy.",
"operationId": "devices-set-split-tunnel-exclude-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40491,7 +44830,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/split_tunnel" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40499,7 +44841,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" }
+ }
},
"description": "Set Split Tunnel Exclude List for a Device Settings Policy response"
},
@@ -40527,7 +44871,12 @@
"description": "Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.",
"operationId": "devices-get-local-domain-fallback-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40538,7 +44887,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" }
+ }
},
"description": "Get Local Domain Fallback List for a Device Settings Policy response"
},
@@ -40564,7 +44915,12 @@
"description": "Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.",
"operationId": "devices-set-local-domain-fallback-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40575,7 +44931,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/fallback_domain" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40583,7 +44942,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" }
+ }
},
"description": "Set Local Domain Fallback List for a Device Settings Policy response"
},
@@ -40611,7 +44972,12 @@
"description": "Get the list of routes included in the WARP client's tunnel for one specific device settings policy.",
"operationId": "devices-get-split-tunnel-include-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40623,7 +44989,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/split_tunnel_include_response_collection"
+ }
}
},
"description": "Get Split Tunnel Include List for a Device Settings Policy response"
@@ -40650,7 +45018,12 @@
"description": "Set the list of routes included in the WARP client's tunnel for one specific device settings policy.",
"operationId": "devices-set-split-tunnel-include-list-for-a-device-settings-policy",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -40661,7 +45034,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" }
+ "schema": {
+ "items": { "$ref": "#/components/schemas/split_tunnel_include" },
+ "type": "array"
+ }
}
},
"required": true
@@ -40670,7 +45046,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/split_tunnel_include_response_collection"
+ }
}
},
"description": "Set Split Tunnel Include List for a Device Settings Policy response"
@@ -40703,14 +45081,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-response_collection"
+ }
}
},
"description": "List Device Posture Rules response"
@@ -40720,7 +45102,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-rules_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -40741,7 +45125,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -40749,13 +45135,19 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-description"
+ },
"expiration": { "$ref": "#/components/schemas/schemas-expiration" },
"input": { "$ref": "#/components/schemas/schemas-input" },
"match": { "$ref": "#/components/schemas/schemas-match" },
- "name": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-name"
+ },
"schedule": { "$ref": "#/components/schemas/schedule" },
- "type": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-type" }
+ "type": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-type"
+ }
},
"required": ["name", "type"]
}
@@ -40767,7 +45159,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ }
}
},
"description": "Create Device Posture Rule response"
@@ -40777,7 +45171,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -40800,7 +45196,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier"
+ }
}
],
"responses": {
@@ -40842,7 +45240,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -40852,8 +45252,12 @@
"properties": {
"config": { "$ref": "#/components/schemas/config_request" },
"interval": { "$ref": "#/components/schemas/schemas-interval" },
- "name": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type"
+ }
},
"required": ["name", "type", "interval", "config"]
}
@@ -40877,7 +45281,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -40900,13 +45306,17 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -40914,7 +45324,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-id_response"
+ }
}
},
"description": "Delete Device Posture Integration response"
@@ -40924,7 +45336,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-id_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-id_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -40945,13 +45359,17 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier"
+ }
}
],
"responses": {
@@ -40970,7 +45388,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -40991,13 +45411,17 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -41007,8 +45431,12 @@
"properties": {
"config": { "$ref": "#/components/schemas/config_request" },
"interval": { "$ref": "#/components/schemas/schemas-interval" },
- "name": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type"
+ }
}
}
}
@@ -41031,7 +45459,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-integrations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -41054,13 +45484,17 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -41068,7 +45502,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-id_response"
+ }
}
},
"description": "Delete Device Posture Rule response"
@@ -41078,7 +45514,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-rules_components-schemas-id_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-id_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -41099,20 +45537,26 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ }
}
},
"description": "Device Posture Rules Details response"
@@ -41122,7 +45566,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -41143,13 +45589,17 @@
"in": "path",
"name": "uuid",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid"
+ }
},
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -41157,13 +45607,19 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-description"
+ },
"expiration": { "$ref": "#/components/schemas/schemas-expiration" },
"input": { "$ref": "#/components/schemas/schemas-input" },
"match": { "$ref": "#/components/schemas/schemas-match" },
- "name": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-name"
+ },
"schedule": { "$ref": "#/components/schemas/schedule" },
- "type": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-type" }
+ "type": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-type"
+ }
},
"required": ["name", "type"]
}
@@ -41175,7 +45631,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ }
}
},
"description": "Update Device Posture Rule response"
@@ -41185,7 +45643,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/device-posture-rules_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -41212,12 +45672,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revoke_devices_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/revoke_devices_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Revoke Devices response"
},
"4xx": {
@@ -41255,7 +45723,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/gateway-account-device-settings-response" }
+ "schema": {
+ "$ref": "#/components/schemas/gateway-account-device-settings-response"
+ }
}
},
"description": "Get device settings for Zero Trust account response"
@@ -41291,7 +45761,9 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-device-settings" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/gateway-account-device-settings" }
+ }
},
"required": true
},
@@ -41299,7 +45771,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/gateway-account-device-settings-response" }
+ "schema": {
+ "$ref": "#/components/schemas/gateway-account-device-settings-response"
+ }
}
},
"description": "Update device settings for the Zero Trust account response"
@@ -41336,12 +45810,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unrevoke_devices_request" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/unrevoke_devices_request" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Unrevoke Devices response"
},
"4xx": {
@@ -41368,7 +45850,12 @@
"description": "Fetch a single Device.",
"operationId": "devices-device-details",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -41378,7 +45865,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/device_response" } }
+ },
"description": "Device Details response"
},
"4xx": {
@@ -41405,7 +45894,12 @@
"description": "Fetch one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration.",
"operationId": "devices-list-admin-override-code-for-device",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -41415,7 +45909,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/override_codes_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/override_codes_response" }
+ }
+ },
"description": "List Admin Override code for device response"
},
"4xx": {
@@ -41451,7 +45949,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } }
+ },
"description": "Get Zero Trust account information response"
},
"4xx": {
@@ -41496,7 +45996,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } }
+ },
"description": "Create Zero Trust account response"
},
"4xx": {
@@ -41534,7 +46036,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/app-types_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/app-types_components-schemas-response_collection"
+ }
}
},
"description": "List Application and Application Type mappings response"
@@ -41544,7 +46048,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/app-types_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/app-types_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -41572,7 +46078,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account_config" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/gateway_account_config" }
+ }
+ },
"description": "Get Zero Trust account configuration response"
},
"4xx": {
@@ -41605,12 +46115,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-settings" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/gateway-account-settings" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account_config" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/gateway_account_config" }
+ }
+ },
"description": "Update Zero Trust account configuration response"
},
"4xx": {
@@ -41648,7 +46166,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/lists_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/lists_components-schemas-response_collection"
+ }
}
},
"description": "List Zero Trust Lists response"
@@ -41687,7 +46207,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/lists_components-schemas-description-2" },
+ "description": {
+ "$ref": "#/components/schemas/lists_components-schemas-description-2"
+ },
"items": { "$ref": "#/components/schemas/schemas-items" },
"name": { "$ref": "#/components/schemas/lists_components-schemas-name-2" },
"type": { "$ref": "#/components/schemas/lists_components-schemas-type" }
@@ -41701,7 +46223,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_with_list_items" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_with_list_items" }
+ }
},
"description": "Create Zero Trust List response"
},
@@ -41791,7 +46315,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/lists_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/lists_components-schemas-single_response"
+ }
}
},
"description": "Zero Trust List Details response"
@@ -41852,7 +46378,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/lists_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/lists_components-schemas-single_response"
+ }
}
},
"description": "Patch Zero Trust List response"
@@ -41897,7 +46425,9 @@
"application/json": {
"schema": {
"properties": {
- "description": { "$ref": "#/components/schemas/lists_components-schemas-description-2" },
+ "description": {
+ "$ref": "#/components/schemas/lists_components-schemas-description-2"
+ },
"name": { "$ref": "#/components/schemas/lists_components-schemas-name-2" }
},
"required": ["name"]
@@ -41910,7 +46440,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/lists_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/lists_components-schemas-single_response"
+ }
}
},
"description": "Update Zero Trust List response"
@@ -41955,7 +46487,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list_item_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list_item_response_collection" }
+ }
},
"description": "Zero Trust List Items response"
},
@@ -41994,7 +46528,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/locations_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/locations_components-schemas-response_collection"
+ }
}
},
"description": "List Zero Trust Gateway Locations response"
@@ -42004,7 +46540,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/locations_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/locations_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42048,7 +46586,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/locations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/locations_components-schemas-single_response"
+ }
}
},
"description": "Create Zero Trust Gateway Location response"
@@ -42095,7 +46635,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/locations_components-schemas-empty_response" }
+ "schema": {
+ "$ref": "#/components/schemas/locations_components-schemas-empty_response"
+ }
}
},
"description": "Delete Zero Trust Gateway Location response"
@@ -42139,7 +46681,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/locations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/locations_components-schemas-single_response"
+ }
}
},
"description": "Zero Trust Gateway Location Details response"
@@ -42199,7 +46743,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/locations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/locations_components-schemas-single_response"
+ }
}
},
"description": "Update Zero Trust Gateway Location response"
@@ -42239,7 +46785,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings-response" }
+ "schema": {
+ "$ref": "#/components/schemas/gateway-account-logging-settings-response"
+ }
}
},
"description": "Get logging settings for the Zero Trust account response"
@@ -42275,7 +46823,9 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings" }
+ }
},
"required": true
},
@@ -42283,7 +46833,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings-response" }
+ "schema": {
+ "$ref": "#/components/schemas/gateway-account-logging-settings-response"
+ }
}
},
"description": "Update logging settings for the Zero Trust account response"
@@ -42316,14 +46868,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection"
+ }
}
},
"description": "List Proxy Endpoints response"
@@ -42333,7 +46889,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42354,7 +46912,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -42363,7 +46923,9 @@
"schema": {
"properties": {
"ips": { "$ref": "#/components/schemas/components-schemas-ips" },
- "name": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name"
+ },
"subdomain": { "$ref": "#/components/schemas/schemas-subdomain" }
},
"required": ["name", "ips"]
@@ -42376,7 +46938,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ }
}
},
"description": "Create Proxy Endpoint response"
@@ -42386,7 +46950,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42415,7 +46981,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -42423,7 +46991,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-empty_response" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-empty_response"
+ }
}
},
"description": "Delete Proxy Endpoint response"
@@ -42433,7 +47003,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-empty_response" },
+ {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-empty_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42460,14 +47032,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ }
}
},
"description": "Proxy Endpoint Details response"
@@ -42477,7 +47053,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42504,7 +47082,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -42513,7 +47093,9 @@
"schema": {
"properties": {
"ips": { "$ref": "#/components/schemas/components-schemas-ips" },
- "name": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name"
+ },
"subdomain": { "$ref": "#/components/schemas/schemas-subdomain" }
}
}
@@ -42525,7 +47107,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ }
}
},
"description": "Update Proxy Endpoint response"
@@ -42535,7 +47119,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -42565,7 +47151,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/rules_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/rules_components-schemas-response_collection"
+ }
}
},
"description": "List Zero Trust Gateway Rules response"
@@ -42605,7 +47193,9 @@
"schema": {
"properties": {
"action": { "$ref": "#/components/schemas/rules_components-schemas-action-2" },
- "description": { "$ref": "#/components/schemas/rules_components-schemas-description-2" },
+ "description": {
+ "$ref": "#/components/schemas/rules_components-schemas-description-2"
+ },
"device_posture": { "$ref": "#/components/schemas/device_posture" },
"enabled": { "$ref": "#/components/schemas/rules_components-schemas-enabled-3" },
"filters": { "$ref": "#/components/schemas/schemas-filters" },
@@ -42625,7 +47215,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/rules_components-schemas-single_response"
+ }
}
},
"description": "Create Zero Trust Gateway Rule response"
@@ -42716,7 +47308,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/rules_components-schemas-single_response"
+ }
}
},
"description": "Zero Trust Gateway Rule Details response"
@@ -42762,7 +47356,9 @@
"schema": {
"properties": {
"action": { "$ref": "#/components/schemas/rules_components-schemas-action-2" },
- "description": { "$ref": "#/components/schemas/rules_components-schemas-description-2" },
+ "description": {
+ "$ref": "#/components/schemas/rules_components-schemas-description-2"
+ },
"device_posture": { "$ref": "#/components/schemas/device_posture" },
"enabled": { "$ref": "#/components/schemas/rules_components-schemas-enabled-3" },
"filters": { "$ref": "#/components/schemas/schemas-filters" },
@@ -42782,7 +47378,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/rules_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/rules_components-schemas-single_response"
+ }
}
},
"description": "Update Zero Trust Gateway Rule response"
@@ -42860,7 +47458,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" }
+ }
},
"description": "Create Certificate response"
},
@@ -42900,7 +47500,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single_id" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single_id" }
+ }
},
"description": "Revoke Certificate response"
},
@@ -42937,7 +47539,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" }
+ }
},
"description": "Get Certificate response"
},
@@ -43010,7 +47614,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_membership_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_membership_response" }
+ }
},
"description": "List Memberships response"
},
@@ -43057,7 +47663,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/membership_components-schemas-identifier"
+ }
}
}
},
@@ -43081,7 +47689,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/membership_components-schemas-identifier"
+ }
}
}
},
@@ -43115,7 +47725,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_membership_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_membership_response" }
+ }
},
"description": "Membership Details response"
},
@@ -43168,7 +47780,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_membership_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_membership_response" }
+ }
},
"description": "Update Membership response"
},
@@ -43207,7 +47821,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_organization_response" }
+ }
},
"description": "Organization Details response"
},
@@ -43228,9 +47844,16 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Organization Details",
"tags": ["Organizations (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/organization/x-cfDeprecations/org_deprecation" },
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/organization/x-cfDeprecations/org_deprecation"
+ },
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"deprecated": true,
@@ -43247,7 +47870,10 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "properties": { "name": { "$ref": "#/components/schemas/schemas-name" } }, "type": "object" }
+ "schema": {
+ "properties": { "name": { "$ref": "#/components/schemas/schemas-name" } },
+ "type": "object"
+ }
}
},
"required": true
@@ -43255,7 +47881,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_organization_response" }
+ }
},
"description": "Edit Organization response"
},
@@ -43276,9 +47904,16 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Edit Organization",
"tags": ["Organizations (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/organization/x-cfDeprecations/org_deprecation" },
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/organization/x-cfDeprecations/org_deprecation"
+ },
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/audit_logs": {
@@ -43297,7 +47932,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" }
+ }
},
"description": "Get organization audit logs response"
},
@@ -43318,7 +47955,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get organization audit logs",
"tags": ["Audit Logs"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/invites": {
@@ -43337,7 +47979,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_invite_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_invite_response" }
+ }
},
"description": "List Invitations response"
},
@@ -43359,7 +48003,12 @@
"summary": "List Invitations",
"tags": ["Organization Invites"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"deprecated": true,
@@ -43413,7 +48062,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_invite_response" }
+ }
+ },
"description": "Create Invitation response"
},
"4xx": {
@@ -43434,7 +48087,12 @@
"summary": "Create Invitation",
"tags": ["Organization Invites"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/invites/{identifier}": {
@@ -43462,7 +48120,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" }
+ }
}
}
},
@@ -43473,7 +48133,13 @@
"application/json": {
"schema": {
"allOf": [
- { "properties": { "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } } },
+ {
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/invite_components-schemas-identifier"
+ }
+ }
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -43486,7 +48152,12 @@
"summary": "Cancel Invitation",
"tags": ["Organization Invites"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"deprecated": true,
@@ -43508,7 +48179,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_invite_response" }
+ }
+ },
"description": "Invitation Details response"
},
"4xx": {
@@ -43529,7 +48204,12 @@
"summary": "Invitation Details",
"tags": ["Organization Invites"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"deprecated": true,
@@ -43568,7 +48248,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_invite_response" }
+ }
+ },
"description": "Edit Invitation Roles response"
},
"4xx": {
@@ -43589,7 +48273,12 @@
"summary": "Edit Invitation Roles",
"tags": ["Organization Invites"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/members": {
@@ -43608,7 +48297,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_member_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_member_response" }
+ }
},
"description": "List Members response"
},
@@ -43630,7 +48321,12 @@
"summary": "List Members",
"tags": ["Organization Members"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/members/{identifier}": {
@@ -43658,7 +48354,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ }
}
}
},
@@ -43669,7 +48367,13 @@
"application/json": {
"schema": {
"allOf": [
- { "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } } },
+ {
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
+ }
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -43682,7 +48386,12 @@
"summary": "Remove Member",
"tags": ["Organization Members"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"deprecated": true,
@@ -43704,7 +48413,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_member_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_member_response" }
+ }
+ },
"description": "Member Details response"
},
"4xx": {
@@ -43725,7 +48438,12 @@
"summary": "Member Details",
"tags": ["Organization Members"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"deprecated": true,
@@ -43764,7 +48482,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_member_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_member_response" }
+ }
+ },
"description": "Edit Member Roles response"
},
"4xx": {
@@ -43785,7 +48507,12 @@
"summary": "Edit Member Roles",
"tags": ["Organization Members"],
"x-cfPermissionsRequired": { "enum": ["#organization:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/railguns": {
@@ -43804,7 +48531,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_collection" }
+ }
},
"description": "List Railguns response"
},
@@ -43825,7 +48554,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Railguns",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"deprecated": true,
@@ -43842,7 +48576,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } },
+ "properties": {
+ "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" }
+ },
"required": ["name"],
"type": "object"
}
@@ -43852,7 +48588,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Create Railgun response"
},
"4xx": {
@@ -43872,7 +48612,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Railgun",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/railguns/{identifier}": {
@@ -43898,7 +48643,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single_id" }
+ }
},
"description": "Delete Railgun response"
},
@@ -43919,7 +48666,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Railgun",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"deprecated": true,
@@ -43940,7 +48692,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Railgun details response"
},
"4xx": {
@@ -43960,7 +48716,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Railgun details",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"deprecated": true,
@@ -43984,7 +48745,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" } },
+ "properties": {
+ "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" }
+ },
"required": ["enabled"]
}
}
@@ -43993,7 +48756,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Enable or disable a Railgun response"
},
"4xx": {
@@ -44013,7 +48780,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Enable or disable a Railgun",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/railguns/{identifier}/zones": {
@@ -44085,7 +48857,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get Railgun zones",
"tags": ["Organization Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/roles": {
@@ -44104,7 +48881,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_role_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_role_response" }
+ }
},
"description": "List Roles response"
},
@@ -44126,7 +48905,12 @@
"summary": "List Roles",
"tags": ["Organization Roles"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/organizations/{organization_identifier}/roles/{identifier}": {
@@ -44150,7 +48934,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_role_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_role_response" }
+ }
+ },
"description": "Role Details response"
},
"4xx": {
@@ -44171,7 +48959,12 @@
"summary": "Role Details",
"tags": ["Organization Roles"],
"x-cfPermissionsRequired": { "enum": ["#organization:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/radar/annotations/outages": {
@@ -44194,7 +48987,10 @@
"endDate": { "example": "2022-09-08T10:00:28Z", "type": "string" },
"eventType": { "example": "OUTAGE", "type": "string" },
"linkedUrl": { "example": "http://example.com", "type": "string" },
- "locations": { "items": { "example": "MX", "type": "string" }, "type": "array" },
+ "locations": {
+ "items": { "example": "MX", "type": "string" },
+ "type": "array"
+ },
"outage": {
"properties": {
"outageCause": { "example": "CABLE_CUT", "type": "string" },
@@ -44235,10 +49031,19 @@
"asns": { "items": { "type": "integer" }, "type": "array" },
"dataSource": { "example": "ALL", "type": "string" },
"description": { "example": "example", "type": "string" },
- "endDate": { "example": "2022-09-08T10:00:28Z", "type": "string" },
+ "endDate": {
+ "example": "2022-09-08T10:00:28Z",
+ "type": "string"
+ },
"eventType": { "example": "OUTAGE", "type": "string" },
- "linkedUrl": { "example": "http://example.com", "type": "string" },
- "locations": { "items": { "example": "MX", "type": "string" }, "type": "array" },
+ "linkedUrl": {
+ "example": "http://example.com",
+ "type": "string"
+ },
+ "locations": {
+ "items": { "example": "MX", "type": "string" },
+ "type": "array"
+ },
"outage": {
"properties": {
"outageCause": { "example": "CABLE_CUT", "type": "string" },
@@ -44246,8 +49051,14 @@
},
"type": "object"
},
- "scope": { "example": "Colima, Michoacán, México", "type": "string" },
- "startDate": { "example": "2022-09-06T10:00:28Z", "type": "string" }
+ "scope": {
+ "example": "Colima, Michoacán, México",
+ "type": "string"
+ },
+ "startDate": {
+ "example": "2022-09-06T10:00:28Z",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -44370,7 +49181,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -44448,7 +49262,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -44580,7 +49397,11 @@
"series": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -44709,7 +49530,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -44757,11 +49581,23 @@
},
"serie_0": {
"properties": {
- "gre": { "items": { "example": "0.9", "type": "string" }, "type": "array" },
- "icmp": { "items": { "example": "0.1", "type": "string" }, "type": "array" },
- "tcp": { "items": { "example": "70", "type": "string" }, "type": "array" },
+ "gre": {
+ "items": { "example": "0.9", "type": "string" },
+ "type": "array"
+ },
+ "icmp": {
+ "items": { "example": "0.1", "type": "string" },
+ "type": "array"
+ },
+ "tcp": {
+ "items": { "example": "70", "type": "string" },
+ "type": "array"
+ },
"timeseries": { "items": { "type": "string" }, "type": "array" },
- "udp": { "items": { "example": "29", "type": "string" }, "type": "array" }
+ "udp": {
+ "items": { "example": "29", "type": "string" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -44794,7 +49630,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -44842,11 +49681,23 @@
},
"serie_0": {
"properties": {
- "gre": { "items": { "example": "0.9", "type": "string" }, "type": "array" },
- "icmp": { "items": { "example": "0.1", "type": "string" }, "type": "array" },
- "tcp": { "items": { "example": "70", "type": "string" }, "type": "array" },
+ "gre": {
+ "items": { "example": "0.9", "type": "string" },
+ "type": "array"
+ },
+ "icmp": {
+ "items": { "example": "0.1", "type": "string" },
+ "type": "array"
+ },
+ "tcp": {
+ "items": { "example": "70", "type": "string" },
+ "type": "array"
+ },
"timeseries": { "items": { "type": "string" }, "type": "array" },
- "udp": { "items": { "example": "29", "type": "string" }, "type": "array" }
+ "udp": {
+ "items": { "example": "29", "type": "string" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -44892,7 +49743,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -44970,7 +49824,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45063,7 +49920,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45112,7 +49972,11 @@
"series": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -45148,7 +50012,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45251,7 +50118,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45299,14 +50169,30 @@
},
"serie_0": {
"properties": {
- "gre": { "items": { "example": "5", "type": "string" }, "type": "array" },
- "icmp": { "items": { "example": "5", "type": "string" }, "type": "array" },
- "tcp": { "items": { "example": "60", "type": "string" }, "type": "array" },
+ "gre": {
+ "items": { "example": "5", "type": "string" },
+ "type": "array"
+ },
+ "icmp": {
+ "items": { "example": "5", "type": "string" },
+ "type": "array"
+ },
+ "tcp": {
+ "items": { "example": "60", "type": "string" },
+ "type": "array"
+ },
"timeseries": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
- "udp": { "items": { "example": "30", "type": "string" }, "type": "array" }
+ "udp": {
+ "items": { "example": "30", "type": "string" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -45339,7 +50225,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45387,9 +50276,18 @@
},
"serie_0": {
"properties": {
- "gre": { "items": { "example": "5", "type": "string" }, "type": "array" },
- "icmp": { "items": { "example": "5", "type": "string" }, "type": "array" },
- "tcp": { "items": { "example": "60", "type": "string" }, "type": "array" },
+ "gre": {
+ "items": { "example": "5", "type": "string" },
+ "type": "array"
+ },
+ "icmp": {
+ "items": { "example": "5", "type": "string" },
+ "type": "array"
+ },
+ "tcp": {
+ "items": { "example": "60", "type": "string" },
+ "type": "array"
+ },
"timeseries": {
"items": {
"example": "2022-09-15T00:00:00Z",
@@ -45398,7 +50296,10 @@
},
"type": "array"
},
- "udp": { "items": { "example": "30", "type": "string" }, "type": "array" }
+ "udp": {
+ "items": { "example": "30", "type": "string" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -45552,7 +50453,10 @@
"items": {
"properties": {
"originCountryAlpha2": { "example": "US", "type": "string" },
- "originCountryName": { "example": "United States", "type": "string" },
+ "originCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"rank": { "example": "1", "type": "string" },
"targetCountryAlpha2": { "example": "PT", "type": "string" },
"targetCountryName": { "example": "Portugal", "type": "string" },
@@ -45632,7 +50536,10 @@
"items": {
"properties": {
"originCountryAlpha2": { "example": "US", "type": "string" },
- "originCountryName": { "example": "United States", "type": "string" },
+ "originCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"rank": { "example": "1", "type": "string" },
"value": { "example": "0.73996", "type": "string" }
},
@@ -45710,7 +50617,10 @@
"properties": {
"rank": { "example": "1", "type": "string" },
"targetCountryAlpha2": { "example": "US", "type": "string" },
- "targetCountryName": { "example": "United States", "type": "string" },
+ "targetCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "0.73996", "type": "string" }
},
"type": "object"
@@ -45759,7 +50669,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -45808,7 +50721,11 @@
"series": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -45844,7 +50761,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -46193,7 +51113,10 @@
},
"id": { "type": "integer" },
"meta": { "type": "object" },
- "tags": { "items": { "example": "global", "type": "string" }, "type": "array" },
+ "tags": {
+ "items": { "example": "global", "type": "string" },
+ "type": "array"
+ },
"title": { "example": "Top bucket 20000 domains", "type": "string" },
"type": { "example": "RANKING_BUCKET", "type": "string" }
},
@@ -46230,8 +51153,14 @@
},
"id": { "type": "integer" },
"meta": { "type": "object" },
- "tags": { "items": { "example": "global", "type": "string" }, "type": "array" },
- "title": { "example": "Top bucket 20000 domains", "type": "string" },
+ "tags": {
+ "items": { "example": "global", "type": "string" },
+ "type": "array"
+ },
+ "title": {
+ "example": "Top bucket 20000 domains",
+ "type": "string"
+ },
"type": { "example": "RANKING_BUCKET", "type": "string" }
},
"type": "object"
@@ -46266,7 +51195,9 @@
"operationId": "radar-datasets-get-dataset-download-url",
"requestBody": {
"content": {
- "application/json": { "schema": { "properties": { "datasetId": { "type": "integer" } }, "type": "object" } }
+ "application/json": {
+ "schema": { "properties": { "datasetId": { "type": "integer" } }, "type": "object" }
+ }
},
"required": true
},
@@ -46278,7 +51209,9 @@
"properties": {
"dataset": {
"items": {
- "properties": { "url": { "example": "https://example.com/download", "type": "string" } },
+ "properties": {
+ "url": { "example": "https://example.com/download", "type": "string" }
+ },
"type": "object"
},
"type": "array"
@@ -46299,7 +51232,9 @@
"properties": {
"dataset": {
"items": {
- "properties": { "url": { "example": "https://example.com/download", "type": "string" } },
+ "properties": {
+ "url": { "example": "https://example.com/download", "type": "string" }
+ },
"type": "object"
},
"type": "array"
@@ -46343,7 +51278,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -46392,7 +51330,11 @@
"series": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -46428,7 +51370,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -46867,7 +51812,10 @@
"asn": { "type": "integer" },
"name": { "example": "Apple Inc.", "type": "string" },
"nameLong": { "type": "string" },
- "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" }
+ "website": {
+ "example": "https://www.apple.com/support/systemstatus/",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -46894,7 +51842,10 @@
"asn": { "type": "integer" },
"name": { "example": "Apple Inc.", "type": "string" },
"nameLong": { "type": "string" },
- "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" }
+ "website": {
+ "example": "https://www.apple.com/support/systemstatus/",
+ "type": "string"
+ }
},
"type": "object"
},
@@ -46947,7 +51898,10 @@
},
"type": "array"
},
- "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" }
+ "website": {
+ "example": "https://www.apple.com/support/systemstatus/",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -47057,7 +52011,10 @@
},
"type": "array"
},
- "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" }
+ "website": {
+ "example": "https://www.apple.com/support/systemstatus/",
+ "type": "string"
+ }
},
"type": "object"
}
@@ -47212,7 +52169,12 @@
"description": "Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).",
"operationId": "radar-entities-get-location",
"parameters": [
- { "in": "path", "name": "location", "required": true, "schema": { "$ref": "#/components/schemas/location" } }
+ {
+ "in": "path",
+ "name": "location",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/location" }
+ }
],
"responses": {
"200": {
@@ -47805,7 +52767,10 @@
"meta": { "type": "object" },
"serie_0": {
"properties": {
- "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" },
+ "\u003cbrowser name\u003e": {
+ "items": { "type": "string" },
+ "type": "array"
+ },
"timestamps": { "items": { "type": "string" }, "type": "array" }
},
"type": "object"
@@ -47833,7 +52798,10 @@
"meta": { "type": "object" },
"serie_0": {
"properties": {
- "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" },
+ "\u003cbrowser name\u003e": {
+ "items": { "type": "string" },
+ "type": "array"
+ },
"timestamps": { "items": { "type": "string" }, "type": "array" }
},
"type": "object"
@@ -47875,7 +52843,10 @@
"meta": { "type": "object" },
"serie_0": {
"properties": {
- "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" },
+ "\u003cbrowser name\u003e": {
+ "items": { "type": "string" },
+ "type": "array"
+ },
"timestamps": { "items": { "type": "string" }, "type": "array" }
},
"type": "object"
@@ -47903,7 +52874,10 @@
"meta": { "type": "object" },
"serie_0": {
"properties": {
- "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" },
+ "\u003cbrowser name\u003e": {
+ "items": { "type": "string" },
+ "type": "array"
+ },
"timestamps": { "items": { "type": "string" }, "type": "array" }
},
"type": "object"
@@ -50015,7 +54989,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -50193,7 +55170,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -50371,7 +55351,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -50549,7 +55532,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -50727,7 +55713,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -50905,7 +55894,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -51083,7 +56075,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "65", "type": "string" }
},
"type": "object"
@@ -51133,7 +56128,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -51182,7 +56180,11 @@
"series": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -51218,7 +56220,10 @@
"items": {
"properties": {
"dataSource": { "example": "ALL", "type": "string" },
- "description": { "example": "Cable cut in Tonga", "type": "string" },
+ "description": {
+ "example": "Cable cut in Tonga",
+ "type": "string"
+ },
"endTime": {
"example": "2022-09-15T00:00:00Z",
"format": "date-time",
@@ -51423,7 +56428,10 @@
"items": {
"properties": {
"clientCountryAlpha2": { "example": "US", "type": "string" },
- "clientCountryName": { "example": "United States", "type": "string" },
+ "clientCountryName": {
+ "example": "United States",
+ "type": "string"
+ },
"value": { "example": "0.73996", "type": "string" }
},
"type": "object"
@@ -51488,8 +56496,14 @@
},
"serie_0": {
"properties": {
- "\u003cdomain name\u003e": { "items": { "type": "integer" }, "type": "array" },
- "timestamps": { "items": { "example": "2022-09-02", "type": "string" }, "type": "array" }
+ "\u003cdomain name\u003e": {
+ "items": { "type": "integer" },
+ "type": "array"
+ },
+ "timestamps": {
+ "items": { "example": "2022-09-02", "type": "string" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -51537,7 +56551,10 @@
},
"serie_0": {
"properties": {
- "\u003cdomain name\u003e": { "items": { "type": "integer" }, "type": "array" },
+ "\u003cdomain name\u003e": {
+ "items": { "type": "integer" },
+ "type": "array"
+ },
"timestamps": {
"items": { "example": "2022-09-02", "type": "string" },
"type": "array"
@@ -51582,7 +56599,9 @@
"meta": {
"properties": {
"top_0": {
- "properties": { "date": { "example": "2022-09-19", "type": "string" } },
+ "properties": {
+ "date": { "example": "2022-09-19", "type": "string" }
+ },
"type": "object"
}
},
@@ -51621,7 +56640,9 @@
"meta": {
"properties": {
"top_0": {
- "properties": { "date": { "example": "2022-09-19", "type": "string" } },
+ "properties": {
+ "date": { "example": "2022-09-19", "type": "string" }
+ },
"type": "object"
}
},
@@ -51680,7 +56701,10 @@
},
"id": { "type": "integer" },
"meta": { "type": "object" },
- "tags": { "items": { "example": "global", "type": "string" }, "type": "array" },
+ "tags": {
+ "items": { "example": "global", "type": "string" },
+ "type": "array"
+ },
"title": { "example": "Top bucket 20000 domains", "type": "string" },
"type": { "example": "RANKING_BUCKET", "type": "string" }
},
@@ -51717,8 +56741,14 @@
},
"id": { "type": "integer" },
"meta": { "type": "object" },
- "tags": { "items": { "example": "global", "type": "string" }, "type": "array" },
- "title": { "example": "Top bucket 20000 domains", "type": "string" },
+ "tags": {
+ "items": { "example": "global", "type": "string" },
+ "type": "array"
+ },
+ "title": {
+ "example": "Top bucket 20000 domains",
+ "type": "string"
+ },
"type": { "example": "RANKING_BUCKET", "type": "string" }
},
"type": "object"
@@ -51753,7 +56783,9 @@
"operationId": "radar-datasets-get-dataset-download-url",
"requestBody": {
"content": {
- "application/json": { "schema": { "properties": { "datasetId": { "type": "integer" } }, "type": "object" } }
+ "application/json": {
+ "schema": { "properties": { "datasetId": { "type": "integer" } }, "type": "object" }
+ }
},
"required": true
},
@@ -51765,7 +56797,9 @@
"properties": {
"dataset": {
"items": {
- "properties": { "url": { "example": "https://example.com/download", "type": "string" } },
+ "properties": {
+ "url": { "example": "https://example.com/download", "type": "string" }
+ },
"type": "object"
},
"type": "array"
@@ -51786,7 +56820,9 @@
"properties": {
"dataset": {
"items": {
- "properties": { "url": { "example": "https://example.com/download", "type": "string" } },
+ "properties": {
+ "url": { "example": "https://example.com/download", "type": "string" }
+ },
"type": "object"
},
"type": "array"
@@ -51939,7 +56975,10 @@
"categories": {
"items": {
"properties": {
- "categoryAlias": { "example": "streaming", "type": "string" },
+ "categoryAlias": {
+ "example": "streaming",
+ "type": "string"
+ },
"location": { "example": "GLOBAL", "type": "string" }
},
"type": "object"
@@ -52113,7 +57152,11 @@
"serie_0": {
"properties": {
"timestamps": {
- "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" },
+ "items": {
+ "example": "2022-09-15T00:00:00Z",
+ "format": "date-time",
+ "type": "string"
+ },
"type": "array"
},
"values": { "items": { "type": "string" }, "type": "array" }
@@ -52238,7 +57281,10 @@
"top_0": {
"items": {
"properties": {
- "botCategory": { "example": "Search Engine Crawler", "type": "string" },
+ "botCategory": {
+ "example": "Search Engine Crawler",
+ "type": "string"
+ },
"botName": { "example": "GoogleBot", "type": "string" },
"botOwner": { "example": "Google", "type": "string" },
"value": { "example": "29.034407", "type": "string" }
@@ -52317,7 +57363,10 @@
"top_0": {
"items": {
"properties": {
- "botCategory": { "example": "Search Engine Crawler", "type": "string" },
+ "botCategory": {
+ "example": "Search Engine Crawler",
+ "type": "string"
+ },
"botName": { "example": "GoogleBot", "type": "string" },
"botOwner": { "example": "Google", "type": "string" },
"value": { "example": "29.034407", "type": "string" }
@@ -52523,7 +57572,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_collection" }
+ }
},
"description": "List Railguns response"
},
@@ -52544,7 +57595,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Railguns",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"operationId": "railgun-create-railgun",
@@ -52552,7 +57608,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } },
+ "properties": {
+ "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" }
+ },
"required": ["name"],
"type": "object"
}
@@ -52562,7 +57620,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Create Railgun response"
},
"4xx": {
@@ -52582,7 +57644,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Railgun",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/railguns/{identifier}": {
@@ -52601,7 +57668,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single_id" }
+ }
},
"description": "Delete a Railgun response"
},
@@ -52622,7 +57691,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete a Railgun",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"operationId": "railgun-railgun-details",
@@ -52636,7 +57710,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Railgun details response"
},
"4xx": {
@@ -52656,7 +57734,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Railgun details",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Enable or disable a Railgun for all zones connected to it.",
@@ -52673,7 +57756,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" } },
+ "properties": {
+ "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" }
+ },
"required": ["enabled"]
}
}
@@ -52682,7 +57767,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Enable or disable a Railgun response"
},
"4xx": {
@@ -52702,7 +57791,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Enable or disable a Railgun",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/railguns/{identifier}/zones": {
@@ -52767,7 +57861,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Railgun zones",
"tags": ["Railgun"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/user": {
@@ -52775,7 +57874,11 @@
"operationId": "user-user-details",
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_user_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_user_response" }
+ }
+ },
"description": "User Details response"
},
"4xx": {
@@ -52819,7 +57922,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_user_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_user_response" }
+ }
+ },
"description": "Edit User response"
},
"4xx": {
@@ -52850,7 +57957,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" }
+ }
},
"description": "Get user audit logs response"
},
@@ -52881,7 +57990,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/billing_history_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/billing_history_collection" }
+ }
},
"description": "Billing History Details response"
},
@@ -52912,7 +58023,11 @@
"operationId": "user-billing-profile-billing-profile-details",
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/billing_response_single" }
+ }
+ },
"description": "Billing Profile Details response"
},
"4xx": {
@@ -52943,7 +58058,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_collection_response" }
+ }
},
"description": "List IP Access rules response"
},
@@ -52986,7 +58103,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_response" }
+ }
+ },
"description": "Create an IP Access rule response"
},
"4xx": {
@@ -53024,7 +58145,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_id_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_id_response" }
+ }
+ },
"description": "Delete an IP Access rule response"
},
"4xx": {
@@ -53072,7 +58197,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_response" }
+ }
+ },
"description": "Update an IP Access rule response"
},
"4xx": {
@@ -53102,7 +58231,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-collection_invite_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-collection_invite_response" }
+ }
},
"description": "List Invitations response"
},
@@ -53123,7 +58254,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Invitations",
"tags": ["User's Invites"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/user/invites/{identifier}": {
@@ -53140,7 +58276,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_invite_response" }
+ }
+ },
"description": "Invitation Details response"
},
"4xx": {
@@ -53160,7 +58300,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Invitation Details",
"tags": ["User's Invites"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Responds to an invitation.",
@@ -53193,7 +58338,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_invite_response" }
+ }
+ },
"description": "Respond to Invitation response"
},
"4xx": {
@@ -53213,7 +58362,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Respond to Invitation",
"tags": ["User's Invites"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/user/load_balancers/monitors": {
@@ -53224,7 +58378,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-response_collection"
+ }
}
},
"description": "List Monitors response"
@@ -53234,7 +58390,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/monitor_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/monitor_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -53256,7 +58414,9 @@
"schema": {
"properties": {
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -53280,7 +58440,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response"
+ }
}
},
"description": "Create Monitor response"
@@ -53359,7 +58521,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response"
+ }
}
},
"description": "Monitor Details response"
@@ -53399,7 +58563,9 @@
"schema": {
"properties": {
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -53422,7 +58588,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response"
+ }
}
},
"description": "Patch Monitor response"
@@ -53462,7 +58630,9 @@
"schema": {
"properties": {
"allow_insecure": { "$ref": "#/components/schemas/allow_insecure" },
- "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/monitor_components-schemas-description"
+ },
"expected_body": { "$ref": "#/components/schemas/expected_body" },
"expected_codes": { "$ref": "#/components/schemas/expected_codes" },
"follow_redirects": { "$ref": "#/components/schemas/follow_redirects" },
@@ -53486,7 +58656,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/monitor_components-schemas-single_response"
+ }
}
},
"description": "Update Monitor response"
@@ -53547,7 +58719,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } }
+ },
"description": "Preview Monitor response"
},
"4xx": {
@@ -53583,7 +58757,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/references_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/references_response" }
+ }
+ },
"description": "List Monitor References response"
},
"4xx": {
@@ -53613,7 +58791,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/pool_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/pool_components-schemas-response_collection"
+ }
}
},
"description": "List Pools response"
@@ -53644,7 +58824,9 @@
"application/json": {
"schema": {
"properties": {
- "notification_email": { "$ref": "#/components/schemas/patch_pools_notification_email" }
+ "notification_email": {
+ "$ref": "#/components/schemas/patch_pools_notification_email"
+ }
}
}
}
@@ -53655,7 +58837,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/pool_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/pool_components-schemas-response_collection"
+ }
}
},
"description": "Patch Pools response"
@@ -53687,7 +58871,9 @@
"schema": {
"properties": {
"check_regions": { "$ref": "#/components/schemas/check_regions" },
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
"load_shedding": { "$ref": "#/components/schemas/load_shedding" },
@@ -53750,7 +58936,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pool_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pool_components-schemas-id_response" }
+ }
},
"description": "Delete Pool response"
},
@@ -53827,7 +59015,9 @@
"schema": {
"properties": {
"check_regions": { "$ref": "#/components/schemas/check_regions" },
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
@@ -53890,7 +59080,9 @@
"schema": {
"properties": {
"check_regions": { "$ref": "#/components/schemas/check_regions" },
- "description": { "$ref": "#/components/schemas/pool_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/pool_components-schemas-description"
+ },
"disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" },
"enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" },
"latitude": { "$ref": "#/components/schemas/latitude" },
@@ -53952,7 +59144,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } }
+ },
"description": "Pool Health Details response"
},
"4xx": {
@@ -54011,7 +59205,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } }
+ },
"description": "Preview Pool response"
},
"4xx": {
@@ -54048,7 +59244,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-references_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-references_response" }
+ }
},
"description": "List Pool References response"
},
@@ -54085,7 +59283,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_result_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/preview_result_response" }
+ }
+ },
"description": "Preview Result response"
},
"4xx": {
@@ -54115,7 +59317,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/analytics_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/analytics_components-schemas-response_collection"
+ }
}
},
"description": "List Healthcheck Events response"
@@ -54125,7 +59329,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/analytics_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/analytics_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -54146,7 +59352,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_organization_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_organization_response" }
+ }
},
"description": "List Organizations response"
},
@@ -54167,7 +59375,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Organizations",
"tags": ["User's Organizations"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/user/organizations/{identifier}": {
@@ -54188,7 +59401,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
+ },
"type": "object"
}
}
@@ -54201,7 +59416,11 @@
"schema": {
"allOf": [
{
- "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } },
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/common_components-schemas-identifier"
+ }
+ },
"type": "object"
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -54215,7 +59434,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Leave Organization",
"tags": ["User's Organizations"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Gets a specific organization the user is associated with.",
@@ -54231,7 +59455,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_organization_response" }
+ }
},
"description": "Organization Details response"
},
@@ -54252,7 +59478,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Organization Details",
"tags": ["User's Organizations"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/user/subscriptions": {
@@ -54262,7 +59493,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/user_subscription_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/user_subscription_response_collection" }
+ }
},
"description": "Get User Subscriptions response"
},
@@ -54295,7 +59528,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -54305,7 +59540,9 @@
"application/json": {
"schema": {
"properties": {
- "subscription_id": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "subscription_id": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -54347,17 +59584,23 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/user_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/user_subscription_response_single" }
+ }
},
"description": "Update User Subscription response"
},
@@ -54388,7 +59631,11 @@
"operationId": "user-api-tokens-list-tokens",
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_collection" }
+ }
+ },
"description": "List Tokens response"
},
"4xx": {
@@ -54415,12 +59662,16 @@
"description": "Create a new access token.",
"operationId": "user-api-tokens-create-token",
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_payload" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_payload" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_create" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_create" } }
+ },
"description": "Create Token response"
},
"4xx": {
@@ -54451,7 +59702,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_collection" }
+ }
},
"description": "List Permission Groups response"
},
@@ -54482,7 +59735,11 @@
"operationId": "user-api-tokens-verify-token",
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single_segment" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_single_segment" }
+ }
+ },
"description": "Verify Token response"
},
"4xx": {
@@ -54520,7 +59777,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete Token response"
},
"4xx": {
@@ -54556,7 +59817,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Token Details response"
},
"4xx": {
@@ -54591,12 +59854,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-token" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-token" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } }
+ },
"description": "Update Token response"
},
"4xx": {
@@ -54632,10 +59899,17 @@
"schema": { "$ref": "#/components/schemas/schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "type": "object" } } },
+ "required": true
+ },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single_value" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_single_value" }
+ }
+ },
"description": "Roll Token response"
},
"4xx": {
@@ -54695,13 +59969,17 @@
"post": {
"operationId": "zone-create-zone",
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-create" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-create" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-response_single" }
+ }
},
"description": "Create Zone response"
},
@@ -54749,7 +60027,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-id_response"
+ }
}
},
"description": "Delete Load Balancer response"
@@ -54793,7 +60073,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ }
}
},
"description": "Load Balancer Details response"
@@ -54803,7 +60085,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -54841,8 +60125,12 @@
"adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" },
"country_pools": { "$ref": "#/components/schemas/country_pools" },
"default_pools": { "$ref": "#/components/schemas/default_pools" },
- "description": { "$ref": "#/components/schemas/load-balancer_components-schemas-description" },
- "enabled": { "$ref": "#/components/schemas/load-balancer_components-schemas-enabled" },
+ "description": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-description"
+ },
+ "enabled": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-enabled"
+ },
"fallback_pool": { "$ref": "#/components/schemas/fallback_pool" },
"location_strategy": { "$ref": "#/components/schemas/location_strategy" },
"name": { "$ref": "#/components/schemas/load-balancer_components-schemas-name" },
@@ -54850,9 +60138,13 @@
"proxied": { "$ref": "#/components/schemas/schemas-proxied" },
"random_steering": { "$ref": "#/components/schemas/random_steering" },
"region_pools": { "$ref": "#/components/schemas/region_pools" },
- "rules": { "$ref": "#/components/schemas/load-balancer_components-schemas-rules" },
+ "rules": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-rules"
+ },
"session_affinity": { "$ref": "#/components/schemas/session_affinity" },
- "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" },
+ "session_affinity_attributes": {
+ "$ref": "#/components/schemas/session_affinity_attributes"
+ },
"session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" },
"steering_policy": { "$ref": "#/components/schemas/steering_policy" },
"ttl": { "$ref": "#/components/schemas/schemas-ttl" }
@@ -54866,7 +60158,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ }
}
},
"description": "Patch Load Balancer response"
@@ -54876,7 +60170,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -54914,8 +60210,12 @@
"adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" },
"country_pools": { "$ref": "#/components/schemas/country_pools" },
"default_pools": { "$ref": "#/components/schemas/default_pools" },
- "description": { "$ref": "#/components/schemas/load-balancer_components-schemas-description" },
- "enabled": { "$ref": "#/components/schemas/load-balancer_components-schemas-enabled" },
+ "description": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-description"
+ },
+ "enabled": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-enabled"
+ },
"fallback_pool": { "$ref": "#/components/schemas/fallback_pool" },
"location_strategy": { "$ref": "#/components/schemas/location_strategy" },
"name": { "$ref": "#/components/schemas/load-balancer_components-schemas-name" },
@@ -54923,9 +60223,13 @@
"proxied": { "$ref": "#/components/schemas/schemas-proxied" },
"random_steering": { "$ref": "#/components/schemas/random_steering" },
"region_pools": { "$ref": "#/components/schemas/region_pools" },
- "rules": { "$ref": "#/components/schemas/load-balancer_components-schemas-rules" },
+ "rules": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-rules"
+ },
"session_affinity": { "$ref": "#/components/schemas/session_affinity" },
- "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" },
+ "session_affinity_attributes": {
+ "$ref": "#/components/schemas/session_affinity_attributes"
+ },
"session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" },
"steering_policy": { "$ref": "#/components/schemas/steering_policy" },
"ttl": { "$ref": "#/components/schemas/schemas-ttl" }
@@ -54940,7 +60244,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ }
}
},
"description": "Update Load Balancer response"
@@ -54950,7 +60256,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -54979,7 +60287,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete Zone response"
},
"4xx": {
@@ -55015,7 +60327,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-response_single" }
+ }
},
"description": "Zone Details response"
},
@@ -55051,13 +60365,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-patch" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-patch" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-response_single" }
+ }
},
"description": "Edit Zone response"
},
@@ -55097,7 +60415,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/apps_components-schemas-response_collection-2" }
+ "schema": {
+ "$ref": "#/components/schemas/apps_components-schemas-response_collection-2"
+ }
}
},
"description": "List Access Applications response"
@@ -55107,7 +60427,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/apps_components-schemas-response_collection-2" },
+ {
+ "$ref": "#/components/schemas/apps_components-schemas-response_collection-2"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -55132,7 +60454,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["name", "type", "domain"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["name", "type", "domain"] } }
+ },
"required": true
},
"responses": {
@@ -55165,7 +60489,9 @@
"allOf": [
{
"allOf": [
- { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" },
+ {
+ "$ref": "#/components/schemas/apps_components-schemas-single_response-2"
+ },
{
"properties": {
"result": {
@@ -55207,7 +60533,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ca_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/ca_components-schemas-response_collection"
+ }
}
},
"description": "List short-lived certificate CAs response"
@@ -55253,7 +60581,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/apps_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/apps_components-schemas-id_response" }
+ }
},
"description": "Delete an Access application response"
},
@@ -55296,7 +60626,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }
+ "schema": {
+ "$ref": "#/components/schemas/apps_components-schemas-single_response-2"
+ }
}
},
"description": "Get an Access application response"
@@ -55337,7 +60669,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["name", "type", "domain"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["name", "type", "domain"] } }
+ },
"required": true
},
"responses": {
@@ -55370,7 +60704,9 @@
"allOf": [
{
"allOf": [
- { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" },
+ {
+ "$ref": "#/components/schemas/apps_components-schemas-single_response-2"
+ },
{
"properties": {
"result": {
@@ -55418,7 +60754,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" }
+ }
},
"description": "Revoke service tokens response"
},
@@ -55461,7 +60799,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/policy_check_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/policy_check_response" }
+ }
+ },
"description": "Test Access policies response"
},
"4xx": {
@@ -55562,7 +60904,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Get an Access policy response"
@@ -55620,8 +60964,12 @@
"include": { "$ref": "#/components/schemas/include" },
"name": { "$ref": "#/components/schemas/policies_components-schemas-name" },
"precedence": { "$ref": "#/components/schemas/precedence" },
- "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" },
- "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" },
+ "purpose_justification_prompt": {
+ "$ref": "#/components/schemas/purpose_justification_prompt"
+ },
+ "purpose_justification_required": {
+ "$ref": "#/components/schemas/purpose_justification_required"
+ },
"require": { "$ref": "#/components/schemas/schemas-require" }
},
"required": ["name", "decision", "include"]
@@ -55634,7 +60982,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Update an Access policy response"
@@ -55663,7 +61013,12 @@
"description": "Deletes a short-lived certificate CA.",
"operationId": "zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -55675,7 +61030,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-id_response" }
+ }
},
"description": "Delete a short-lived certificate CA response"
},
@@ -55701,7 +61058,12 @@
"description": "Fetches a short-lived certificate CA and its public key.",
"operationId": "zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -55712,7 +61074,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" }
+ }
},
"description": "Get a short-lived certificate CA response"
},
@@ -55738,7 +61102,12 @@
"description": "Generates a new short-lived certificate CA and public key.",
"operationId": "zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -55750,7 +61119,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" }
+ }
},
"description": "Create a short-lived certificate CA response"
},
@@ -55795,7 +61166,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection"
+ }
}
},
"description": "List Access policies response"
@@ -55805,7 +61178,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/policies_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/policies_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -55847,8 +61222,12 @@
"include": { "$ref": "#/components/schemas/include" },
"name": { "$ref": "#/components/schemas/policies_components-schemas-name" },
"precedence": { "$ref": "#/components/schemas/precedence" },
- "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" },
- "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" },
+ "purpose_justification_prompt": {
+ "$ref": "#/components/schemas/purpose_justification_prompt"
+ },
+ "purpose_justification_required": {
+ "$ref": "#/components/schemas/purpose_justification_required"
+ },
"require": { "$ref": "#/components/schemas/schemas-require" }
},
"required": ["name", "decision", "include"]
@@ -55861,7 +61240,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/policies_components-schemas-single_response"
+ }
}
},
"description": "Create an Access policy response"
@@ -55901,7 +61282,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-response_collection"
+ }
}
},
"description": "List mTLS certificates response"
@@ -55911,7 +61294,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -55958,7 +61343,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Add an mTLS certificate response"
@@ -55968,7 +61355,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -55987,7 +61376,12 @@
"description": "Deletes an mTLS certificate.",
"operationId": "zone-level-access-m-tls-authentication-delete-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56000,7 +61394,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-id_response"
+ }
}
},
"description": "Delete an mTLS certificate response"
@@ -56027,7 +61423,12 @@
"description": "Fetches a single mTLS certificate.",
"operationId": "zone-level-access-m-tls-authentication-get-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56039,7 +61440,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Get an mTLS certificate response"
@@ -56049,7 +61452,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56066,7 +61471,12 @@
"description": "Updates a configured mTLS certificate.",
"operationId": "zone-level-access-m-tls-authentication-update-an-m-tls-certificate",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56092,7 +61502,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ }
}
},
"description": "Update an mTLS certificate response"
@@ -56102,7 +61514,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/certificates_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/certificates_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56132,7 +61546,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-response_collection"
+ }
}
},
"description": "List Access groups response"
@@ -56142,7 +61558,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/groups_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/groups_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56186,7 +61604,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Create an Access group response"
@@ -56215,7 +61635,12 @@
"description": "Deletes an Access group.",
"operationId": "zone-level-access-groups-delete-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56227,7 +61652,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/groups_components-schemas-id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/groups_components-schemas-id_response" }
+ }
},
"description": "Delete an Access group response"
},
@@ -56253,7 +61680,12 @@
"description": "Fetches a single Access group.",
"operationId": "zone-level-access-groups-get-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56265,7 +61697,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Get an Access group response"
@@ -56292,7 +61726,12 @@
"description": "Updates a configured Access group.",
"operationId": "zone-level-access-groups-update-an-access-group",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/schemas-uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56320,7 +61759,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/groups_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/groups_components-schemas-single_response"
+ }
}
},
"description": "Update an Access group response"
@@ -56353,14 +61794,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection"
+ }
}
},
"description": "List Access identity providers response"
@@ -56370,7 +61815,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56391,7 +61838,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -56400,8 +61849,12 @@
"schema": {
"properties": {
"config": { "$ref": "#/components/schemas/schemas-config" },
- "name": { "$ref": "#/components/schemas/identity-providers_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/identity-providers_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-type"
+ }
},
"required": ["name", "type", "config"]
}
@@ -56413,7 +61866,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Add an Access identity provider response"
@@ -56423,7 +61878,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56442,12 +61899,19 @@
"description": "Deletes an identity provider from Access.",
"operationId": "zone-level-access-identity-providers-delete-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
@@ -56455,7 +61919,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Delete an Access identity provider response"
@@ -56465,7 +61931,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56482,19 +61950,28 @@
"description": "Fetches a configured identity provider.",
"operationId": "zone-level-access-identity-providers-get-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Get an Access identity provider response"
@@ -56504,7 +61981,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56521,12 +62000,19 @@
"description": "Updates a configured identity provider.",
"operationId": "zone-level-access-identity-providers-update-an-access-identity-provider",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-identifier"
+ }
}
],
"requestBody": {
@@ -56535,8 +62021,12 @@
"schema": {
"properties": {
"config": { "$ref": "#/components/schemas/schemas-config" },
- "name": { "$ref": "#/components/schemas/identity-providers_components-schemas-name" },
- "type": { "$ref": "#/components/schemas/identity-providers_components-schemas-type" }
+ "name": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-name"
+ },
+ "type": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-type"
+ }
},
"required": ["name", "type", "config"]
}
@@ -56548,7 +62038,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ }
}
},
"description": "Update an Access identity provider response"
@@ -56558,7 +62050,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/identity-providers_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56588,7 +62082,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Get your Zero Trust organization response"
@@ -56598,7 +62094,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56642,7 +62140,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Create your Zero Trust organization response"
@@ -56652,7 +62152,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56695,7 +62197,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/organizations_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ }
}
},
"description": "Update your Zero Trust organization response"
@@ -56705,7 +62209,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/organizations_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/organizations_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56750,7 +62256,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-empty_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-empty_response" }
+ }
+ },
"description": "Revoke all Access tokens for a user response"
},
"4xx": {
@@ -56788,7 +62298,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection"
+ }
}
},
"description": "List service tokens response"
@@ -56798,7 +62310,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56826,7 +62340,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } },
+ "properties": {
+ "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }
+ },
"required": ["name"]
}
}
@@ -56835,7 +62351,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } }
+ },
"description": "Create a service token response"
},
"4xx": {
@@ -56862,7 +62380,12 @@
"description": "Deletes a service token.",
"operationId": "zone-level-access-service-tokens-delete-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56875,7 +62398,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ }
}
},
"description": "Delete a service token response"
@@ -56885,7 +62410,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56902,7 +62429,12 @@
"description": "Updates a configured service token.",
"operationId": "zone-level-access-service-tokens-update-a-service-token",
"parameters": [
- { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } },
+ {
+ "in": "path",
+ "name": "uuid",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/uuid" }
+ },
{
"in": "path",
"name": "identifier",
@@ -56914,7 +62446,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } }
+ "properties": {
+ "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }
+ }
}
}
},
@@ -56924,7 +62458,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ }
}
},
"description": "Update a service token response"
@@ -56934,7 +62470,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/service-tokens_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -56963,7 +62501,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Zone Activation Check response"
},
"4xx": {
@@ -57006,7 +62548,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -57021,7 +62566,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -57057,7 +62605,10 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
}
}
@@ -57072,7 +62623,10 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/result" } }, "type": "object" }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/result" } },
+ "type": "object"
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -57105,7 +62659,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection"
+ }
}
},
"description": "List Load Balancers response"
@@ -57115,7 +62671,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -57147,7 +62705,9 @@
"adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" },
"country_pools": { "$ref": "#/components/schemas/country_pools" },
"default_pools": { "$ref": "#/components/schemas/default_pools" },
- "description": { "$ref": "#/components/schemas/load-balancer_components-schemas-description" },
+ "description": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-description"
+ },
"fallback_pool": { "$ref": "#/components/schemas/fallback_pool" },
"location_strategy": { "$ref": "#/components/schemas/location_strategy" },
"name": { "$ref": "#/components/schemas/load-balancer_components-schemas-name" },
@@ -57155,9 +62715,13 @@
"proxied": { "$ref": "#/components/schemas/schemas-proxied" },
"random_steering": { "$ref": "#/components/schemas/random_steering" },
"region_pools": { "$ref": "#/components/schemas/region_pools" },
- "rules": { "$ref": "#/components/schemas/load-balancer_components-schemas-rules" },
+ "rules": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-rules"
+ },
"session_affinity": { "$ref": "#/components/schemas/session_affinity" },
- "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" },
+ "session_affinity_attributes": {
+ "$ref": "#/components/schemas/session_affinity_attributes"
+ },
"session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" },
"steering_policy": { "$ref": "#/components/schemas/steering_policy" },
"ttl": { "$ref": "#/components/schemas/schemas-ttl" }
@@ -57172,7 +62736,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ }
}
},
"description": "Create Load Balancer response"
@@ -57182,7 +62748,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/load-balancer_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -57218,7 +62786,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Purge Files by Cache-Tags, Host, or Prefix response"
},
"4xx": {
@@ -57239,7 +62811,12 @@
"summary": "Purge Files by Cache-Tags, Host, or Prefix",
"tags": ["Zone"],
"x-cfPermissionsRequired": { "enum": ["#cache_purge:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/force_axfr": {
@@ -57251,13 +62828,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/force_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/force_response" } }
+ },
"description": "Force AXFR response"
},
"4xx": {
@@ -57278,7 +62859,12 @@
"summary": "Force AXFR",
"tags": ["Secondary DNS (Secondary Zone)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/incoming": {
@@ -57290,13 +62876,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } }
+ },
"description": "Delete Secondary Zone Configuration response"
},
"4xx": {
@@ -57317,7 +62907,12 @@
"summary": "Delete Secondary Zone Configuration",
"tags": ["Secondary DNS (Secondary Zone)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get secondary zone configuration for incoming zone transfers.",
@@ -57327,13 +62922,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_incoming" }
+ }
},
"description": "Secondary Zone Configuration Details response"
},
@@ -57355,7 +62954,12 @@
"summary": "Secondary Zone Configuration Details",
"tags": ["Secondary DNS (Secondary Zone)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create secondary zone configuration for incoming zone transfers.",
@@ -57365,19 +62969,25 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_incoming" }
+ }
},
"description": "Create Secondary Zone Configuration response"
},
@@ -57399,7 +63009,12 @@
"summary": "Create Secondary Zone Configuration",
"tags": ["Secondary DNS (Secondary Zone)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update secondary zone configuration for incoming zone transfers.",
@@ -57409,19 +63024,25 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_incoming" }
+ }
},
"description": "Update Secondary Zone Configuration response"
},
@@ -57443,7 +63064,12 @@
"summary": "Update Secondary Zone Configuration",
"tags": ["Secondary DNS (Secondary Zone)"],
"x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/outgoing": {
@@ -57455,13 +63081,19 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-id_response" }
+ }
+ },
"description": "Delete Primary Zone Configuration response"
},
"4xx": {
@@ -57481,7 +63113,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Primary Zone Configuration",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get primary zone configuration for outgoing zone transfers.",
@@ -57491,13 +63128,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_outgoing" }
+ }
},
"description": "Primary Zone Configuration Details response"
},
@@ -57518,7 +63159,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Primary Zone Configuration Details",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Create primary zone configuration for outgoing zone transfers.",
@@ -57528,17 +63174,25 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_request_outgoing" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_request_outgoing" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_outgoing" }
+ }
},
"description": "Create Primary Zone Configuration response"
},
@@ -57559,7 +63213,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Primary Zone Configuration",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Update primary zone configuration for outgoing zone transfers.",
@@ -57569,17 +63228,25 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_request_outgoing" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_request_outgoing" }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/single_response_outgoing" }
+ }
},
"description": "Update Primary Zone Configuration response"
},
@@ -57600,7 +63267,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update Primary Zone Configuration",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/outgoing/disable": {
@@ -57612,14 +63284,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/disable_transfer_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/disable_transfer_response" }
+ }
},
"description": "Disable Outgoing Zone Transfers response"
},
@@ -57640,7 +63316,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Disable Outgoing Zone Transfers",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/outgoing/enable": {
@@ -57652,14 +63333,18 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/enable_transfer_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/enable_transfer_response" }
+ }
},
"description": "Enable Outgoing Zone Transfers response"
},
@@ -57680,7 +63365,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Enable Outgoing Zone Transfers",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/outgoing/force_notify": {
@@ -57692,13 +63382,19 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-force_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-force_response" }
+ }
+ },
"description": "Force DNS NOTIFY response"
},
"4xx": {
@@ -57718,7 +63414,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Force DNS NOTIFY",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/secondary_dns/outgoing/status": {
@@ -57730,13 +63431,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/enable_transfer_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/enable_transfer_response" }
+ }
},
"description": "Get Outgoing Zone Transfer Status response"
},
@@ -57757,7 +63462,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get Outgoing Zone Transfer Status",
"tags": ["Secondary DNS (Primary Zone)"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{identifier}/ssl/analyze": {
@@ -57789,7 +63499,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_analyze_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_analyze_response" }
+ }
},
"description": "Analyze Certificate response"
},
@@ -57823,13 +63535,17 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
}
],
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" }
+ }
},
"description": "Zone Subscription Details response"
},
@@ -57861,17 +63577,23 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" }
+ }
},
"description": "Create Zone Subscription response"
},
@@ -57903,17 +63625,23 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier"
+ }
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" }
+ }
},
"description": "Update Zone Subscription response"
},
@@ -57953,7 +63681,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/total_tls_settings_response" }
+ }
},
"description": "Total TLS Settings Details response"
},
@@ -57993,7 +63723,9 @@
"application/json": {
"schema": {
"properties": {
- "certificate_authority": { "$ref": "#/components/schemas/schemas-certificate_authority" },
+ "certificate_authority": {
+ "$ref": "#/components/schemas/schemas-certificate_authority"
+ },
"enabled": { "$ref": "#/components/schemas/total-tls_components-schemas-enabled" }
},
"required": ["enabled"]
@@ -58005,7 +63737,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/total_tls_settings_response" }
+ }
},
"description": "Enable or Disable Total TLS response"
},
@@ -58045,7 +63779,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/colo_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/colo_response" } }
+ },
"description": "Get analytics by Co-locations response"
},
"4xx": {
@@ -58065,9 +63801,16 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get analytics by Co-locations",
"tags": ["Zone Analytics (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation" },
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation"
+ },
"x-cfPermissionsRequired": { "enum": ["#analytics:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/analytics/dashboard": {
@@ -58085,7 +63828,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dashboard_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dashboard_response" }
+ }
+ },
"description": "Get dashboard response"
},
"4xx": {
@@ -58105,7 +63852,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get dashboard",
"tags": ["Zone Analytics (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation" },
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/analytics/x-cfDeprecations/zone_analytics_deprecation"
+ },
"x-cfPermissionsRequired": { "enum": ["#analytics:read"] },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
@@ -58123,7 +63872,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_single" }
+ }
+ },
"description": "Argo Analytics for a zone response"
},
"4xx": {
@@ -58160,7 +63913,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_single" }
+ }
+ },
"description": "Argo Analytics for a zone at different PoPs response"
},
"4xx": {
@@ -58197,7 +63954,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_single" }
+ }
+ },
"description": "Get Argo Smart Routing setting response"
},
"4xx": {
@@ -58237,7 +63998,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_single" }
+ }
+ },
"description": "Patch Argo Smart Routing setting response"
},
"4xx": {
@@ -58282,7 +64047,10 @@
{ "$ref": "#/components/schemas/api-response-collection" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/available-rate-plan" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/available-rate-plan" },
+ "type": "array"
+ }
}
}
]
@@ -58349,7 +64117,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/available-rate-plan" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/available-rate-plan" }
+ }
+ }
]
}
}
@@ -58364,7 +64136,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-single" },
- { "properties": { "result": { "$ref": "#/components/schemas/available-rate-plan" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/available-rate-plan" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -58397,7 +64173,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/plan_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/plan_response_collection" }
+ }
},
"description": "List Available Rate Plans response"
},
@@ -58714,7 +64492,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_collection" }
+ }
},
"description": "List SSL Configurations response"
},
@@ -58736,7 +64516,12 @@
"summary": "List SSL Configurations",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Upload a new SSL certificate for a zone.",
@@ -58759,7 +64544,9 @@
"geo_restrictions": { "$ref": "#/components/schemas/geo_restrictions" },
"policy": { "$ref": "#/components/schemas/policy" },
"private_key": { "$ref": "#/components/schemas/private_key" },
- "type": { "$ref": "#/components/schemas/custom-certificate_components-schemas-type" }
+ "type": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-type"
+ }
},
"required": ["certificate", "private_key"],
"type": "object"
@@ -58771,7 +64558,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "Create SSL Configuration response"
},
@@ -58793,7 +64582,12 @@
"summary": "Create SSL Configuration",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/custom_certificates/prioritize": {
@@ -58821,7 +64615,9 @@
],
"items": {
"properties": {
- "id": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" },
+ "id": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier"
+ },
"priority": { "$ref": "#/components/schemas/schemas-priority" }
},
"type": "object"
@@ -58838,7 +64634,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_collection" }
+ }
},
"description": "Re-prioritize SSL Certificates response"
},
@@ -58860,7 +64658,12 @@
"summary": "Re-prioritize SSL Certificates",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/custom_certificates/{identifier}": {
@@ -58872,7 +64675,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -58885,7 +64690,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_id_only" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_id_only" }
+ }
},
"description": "Delete SSL Configuration response"
},
@@ -58907,7 +64714,12 @@
"summary": "Delete SSL Configuration",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"operationId": "custom-ssl-for-a-zone-ssl-configuration-details",
@@ -58916,7 +64728,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -58928,7 +64742,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "SSL Configuration Details response"
},
@@ -58950,7 +64766,12 @@
"summary": "SSL Configuration Details",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.",
@@ -58960,7 +64781,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -58989,7 +64812,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "Edit SSL Configuration response"
},
@@ -59011,7 +64836,12 @@
"summary": "Edit SSL Configuration",
"tags": ["Custom SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/custom_hostnames": {
@@ -59029,7 +64859,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_hostname_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_hostname_response_collection" }
+ }
},
"description": "List Custom Hostnames response"
},
@@ -59082,7 +64914,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" }
+ }
},
"description": "Create Custom Hostname response"
},
@@ -59122,7 +64956,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_origin_response" }
+ }
},
"description": "Delete Fallback Origin for Custom Hostnames response"
},
@@ -59159,7 +64995,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_origin_response" }
+ }
},
"description": "Get Fallback Origin for Custom Hostnames response"
},
@@ -59208,7 +65046,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/fallback_origin_response" }
+ }
},
"description": "Update Fallback Origin for Custom Hostnames response"
},
@@ -59241,7 +65081,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -59257,7 +65099,9 @@
"application/json": {
"schema": {
"properties": {
- "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier"
+ }
},
"type": "object"
}
@@ -59272,7 +65116,9 @@
"allOf": [
{
"properties": {
- "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier"
+ }
},
"type": "object"
},
@@ -59297,7 +65143,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -59309,7 +65157,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" }
+ }
},
"description": "Custom Hostname Details response"
},
@@ -59341,7 +65191,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -59369,7 +65221,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_hostname_response_single" }
+ }
},
"description": "Edit Custom Hostname response"
},
@@ -59407,7 +65261,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/get_response" } }
+ },
"description": "Get Account Custom Nameserver Related Zone Metadata response"
},
"4xx": {
@@ -59428,7 +65284,12 @@
"summary": "Get Account Custom Nameserver Related Zone Metadata",
"tags": ["Account-Level Custom Nameservers Usage for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"operationId": "account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata",
@@ -59441,12 +65302,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_metadata" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/zone_metadata" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } }
+ },
"description": "Set Account Custom Nameserver Related Zone Metadata response"
},
"4xx": {
@@ -59467,7 +65332,12 @@
"summary": "Set Account Custom Nameserver Related Zone Metadata",
"tags": ["Account-Level Custom Nameservers Usage for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/custom_pages": {
@@ -59485,7 +65355,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" }
+ }
},
"description": "List custom pages response"
},
@@ -59531,7 +65403,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_single" }
+ }
},
"description": "Get a custom page response"
},
@@ -59589,7 +65463,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/custom_pages_response_single" }
+ }
},
"description": "Update a custom page response"
},
@@ -59628,7 +65504,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_collection" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_collection" }
+ }
+ },
"description": "List DNS Records response"
},
"4xx": {
@@ -59683,7 +65563,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_single" }
+ }
+ },
"description": "Create DNS Record response"
},
"4xx": {
@@ -59720,11 +65604,16 @@
}
],
"responses": {
- "200": { "content": { "application/json": { "schema": {} } }, "description": "Export DNS Records response" },
+ "200": {
+ "content": { "application/json": { "schema": {} } },
+ "description": "Export DNS Records response"
+ },
"4xx": {
"content": {
"application/json": {
- "schema": { "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }] }
+ "schema": {
+ "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }]
+ }
}
},
"description": "Export DNS Records response failure"
@@ -59754,7 +65643,11 @@
"multipart/form-data": {
"schema": {
"properties": {
- "file": { "description": "BIND config to upload.", "example": "@bind_config.txt", "type": "string" },
+ "file": {
+ "description": "BIND config to upload.",
+ "example": "@bind_config.txt",
+ "type": "string"
+ },
"proxied": {
"description": "Whether or not proxiable records should receive the performance and security benefits of Cloudflare.",
"example": false,
@@ -59771,7 +65664,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_import_scan" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_import_scan" }
+ }
},
"description": "Import DNS Records response"
},
@@ -59812,7 +65707,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_import_scan" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_import_scan" }
+ }
},
"description": "Scan DNS Records response"
},
@@ -59863,7 +65760,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/dns-record_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/dns-record_components-schemas-identifier"
+ }
}
}
},
@@ -59882,7 +65781,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/dns-record_components-schemas-identifier" }
+ "id": {
+ "$ref": "#/components/schemas/dns-record_components-schemas-identifier"
+ }
}
}
},
@@ -59920,7 +65821,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_single" }
+ }
+ },
"description": "DNS Record Details response"
},
"4xx": {
@@ -59978,7 +65883,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_single" }
+ }
+ },
"description": "Patch DNS Record response"
},
"4xx": {
@@ -60037,7 +65946,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns_response_single" }
+ }
+ },
"description": "Update DNS Record response"
},
"4xx": {
@@ -60077,7 +65990,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/delete_dnssec_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/delete_dnssec_response_single" }
+ }
},
"description": "Delete DNSSEC records response"
},
@@ -60114,7 +66029,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnssec_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dnssec_response_single" }
+ }
+ },
"description": "DNSSEC Details response"
},
"4xx": {
@@ -60167,7 +66086,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnssec_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dnssec_response_single" }
+ }
+ },
"description": "Edit DNSSEC Status response"
},
"4xx": {
@@ -60206,7 +66129,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/email-settings_response_single" }
+ }
},
"description": "Get Email Routing settings response"
},
@@ -60227,7 +66152,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get Email Routing settings",
"tags": ["Email Routing settings"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60247,7 +66174,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/email-settings_response_single" }
+ }
},
"description": "Disable Email Routing response"
},
@@ -60268,7 +66197,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Disable Email Routing",
"tags": ["Email Routing settings"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60287,7 +66218,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/dns-settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/dns-settings_response_collection" }
+ }
},
"description": "Email Routing - DNS settings response"
},
@@ -60308,7 +66241,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Email Routing - DNS settings",
"tags": ["Email Routing settings"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60328,7 +66263,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/email-settings_response_single" }
+ }
},
"description": "Enable Email Routing response"
},
@@ -60349,7 +66286,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Enable Email Routing",
"tags": ["Email Routing settings"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60368,7 +66307,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rules_response_collection" }
+ }
},
"description": "List routing rules response"
},
@@ -60389,7 +66330,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List routing rules",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.list"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.list"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"post": {
@@ -60404,12 +66347,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_rule_properties" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/create_rule_properties" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_single" }
+ }
+ },
"description": "Create routing rule response"
},
"4xx": {
@@ -60429,7 +66380,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create routing rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.create"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.create"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60448,7 +66401,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" }
+ }
},
"description": "Get catch-all rule response"
},
@@ -60469,7 +66424,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get catch-all rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"put": {
@@ -60485,14 +66442,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/update_catch_all_rule_properties" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_catch_all_rule_properties" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" }
+ }
},
"description": "Update catch-all rule response"
},
@@ -60513,7 +66474,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update catch-all rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60538,7 +66501,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_single" }
+ }
+ },
"description": "Delete routing rule response"
},
"4xx": {
@@ -60558,7 +66525,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete routing rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.delete"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.delete"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"get": {
@@ -60580,7 +66549,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_single" }
+ }
+ },
"description": "Get routing rule response"
},
"4xx": {
@@ -60600,7 +66573,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get routing rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
},
"put": {
@@ -60621,12 +66596,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_rule_properties" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/update_rule_properties" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_single" }
+ }
+ },
"description": "Update routing rule response"
},
"4xx": {
@@ -60646,7 +66629,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update routing rule",
"tags": ["Email Routing routing rules"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"] },
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"]
+ },
"x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true }
}
},
@@ -60666,7 +66651,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "id": { "$ref": "#/components/schemas/filters_components-schemas-id" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/filters_components-schemas-id" }
+ },
"required": ["id"],
"type": "object"
}
@@ -60677,7 +66664,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-delete-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-delete-response-collection" }
+ }
},
"description": "Delete filters response"
},
@@ -60714,7 +66703,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" }
+ }
},
"description": "List filters response"
},
@@ -60755,7 +66746,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" }
+ }
},
"description": "Create filters response"
},
@@ -60789,11 +66782,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" }
+ }
},
"description": "Update filters response"
},
@@ -60839,7 +66837,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-delete-response-single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-delete-response-single" }
+ }
},
"description": "Delete a filter response"
},
@@ -60882,7 +66882,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" }
+ }
},
"description": "Get a filter response"
},
@@ -60922,11 +66924,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" }
+ }
},
"description": "Update a filter response"
},
@@ -60965,7 +66972,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zonelockdown_response_collection" }
+ }
},
"description": "List Zone Lockdown rules response"
},
@@ -61000,13 +67009,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["urls", "configurations"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["urls", "configurations"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" }
+ }
},
"description": "Create a Zone Lockdown rule response"
},
@@ -61056,7 +67069,9 @@
"schema": {
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" }
+ }
}
},
"type": "object"
@@ -61073,7 +67088,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" }
+ }
}
},
"type": "object"
@@ -61111,7 +67128,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" }
+ }
},
"description": "Get a Zone Lockdown rule response"
},
@@ -61152,13 +67171,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["urls", "configurations"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["urls", "configurations"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" }
+ }
},
"description": "Update a Zone Lockdown rule response"
},
@@ -61198,7 +67221,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "id": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } },
+ "properties": {
+ "id": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" }
+ },
"required": ["id"],
"type": "object"
}
@@ -61248,7 +67273,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" }
+ }
},
"description": "List firewall rules response"
},
@@ -61282,11 +67309,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" }
+ }
},
"description": "Update priority of firewall rules response"
},
@@ -61327,7 +67359,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" }
+ }
},
"description": "Create firewall rules response"
},
@@ -61361,11 +67395,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" }
+ }
},
"description": "Update firewall rules response"
},
@@ -61411,7 +67450,11 @@
"content": {
"application/json": {
"schema": {
- "properties": { "delete_filter_if_unused": { "$ref": "#/components/schemas/delete_filter_if_unused" } },
+ "properties": {
+ "delete_filter_if_unused": {
+ "$ref": "#/components/schemas/delete_filter_if_unused"
+ }
+ },
"type": "object"
}
}
@@ -61421,7 +67464,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response-delete" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-single-response-delete" }
+ }
},
"description": "Delete a firewall rule response"
},
@@ -61464,7 +67509,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-single-response" }
+ }
},
"description": "Get a firewall rule response"
},
@@ -61504,11 +67551,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["id"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" }
+ }
},
"description": "Update priority of a firewall rule response"
},
@@ -61549,13 +67601,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["id", "filter", "action"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["id", "filter", "action"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-rules-single-response" }
+ }
},
"description": "Update a firewall rule response"
},
@@ -61594,7 +67650,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/firewalluablock_response_collection" }
+ }
},
"description": "List User Agent Blocking rules response"
},
@@ -61629,13 +67687,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["mode", "configuration"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["mode", "configuration"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" }
+ }
},
"description": "Create a User Agent Blocking rule response"
},
@@ -61688,7 +67750,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" }
+ }
}
},
"type": "object"
@@ -61710,7 +67774,11 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } }
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/ua-rules_components-schemas-id"
+ }
+ }
}
},
"type": "object"
@@ -61750,7 +67818,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" }
+ }
},
"description": "Get a User Agent Blocking rule response"
},
@@ -61791,13 +67861,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["id", "mode", "configuration"] } } },
+ "content": {
+ "application/json": { "schema": { "required": ["id", "mode", "configuration"] } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" }
+ }
},
"description": "Update a User Agent Blocking rule response"
},
@@ -61836,7 +67910,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/override_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/override_response_collection" }
+ }
},
"description": "List WAF overrides response"
},
@@ -61857,7 +67933,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List WAF overrides",
"tags": ["WAF overrides"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates a URI-based WAF override for a zone.",
@@ -61870,11 +67951,16 @@
"schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" }
}
],
- "requestBody": { "content": { "application/json": { "schema": { "required": ["urls"] } } }, "required": true },
+ "requestBody": {
+ "content": { "application/json": { "schema": { "required": ["urls"] } } },
+ "required": true
+ },
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/override_response_single" }
+ }
},
"description": "Create a WAF override response"
},
@@ -61895,7 +67981,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create a WAF override",
"tags": ["WAF overrides"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/firewall/waf/overrides/{id}": {
@@ -61924,7 +68015,9 @@
"schema": {
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" }
+ }
}
},
"type": "object"
@@ -61941,7 +68034,9 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" } }
+ "properties": {
+ "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" }
+ }
}
},
"type": "object"
@@ -61957,7 +68052,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete a WAF override",
"tags": ["WAF overrides"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Fetches the details of a URI-based WAF override.",
@@ -61979,7 +68079,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/override_response_single" }
+ }
},
"description": "Get a WAF override response"
},
@@ -62000,7 +68102,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get a WAF override",
"tags": ["WAF overrides"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates an existing URI-based WAF override.",
@@ -62020,13 +68127,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["id", "urls", "rules", "rewrite_action"] } } },
+ "content": {
+ "application/json": {
+ "schema": { "required": ["id", "urls", "rules", "rewrite_action"] }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/override_response_single" }
+ }
},
"description": "Update WAF override response"
},
@@ -62047,7 +68160,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update WAF override",
"tags": ["WAF overrides"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/firewall/waf/packages": {
@@ -62065,7 +68183,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/package_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/package_response_collection" }
+ }
},
"description": "List WAF packages response"
},
@@ -62109,7 +68229,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/package_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/package_response_single" }
+ }
+ },
"description": "Get a WAF package response"
},
"4xx": {
@@ -62169,7 +68293,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/package_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/anomaly_package" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/anomaly_package" } }
+ }
]
}
}
@@ -62184,7 +68310,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/package_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/anomaly_package" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/anomaly_package" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -62222,7 +68352,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_group_response_collection" }
+ }
},
"description": "List WAF rule groups response"
},
@@ -62273,7 +68405,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_group_response_single" }
+ }
},
"description": "Get a WAF rule group response"
},
@@ -62322,7 +68456,9 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "properties": { "mode": { "$ref": "#/components/schemas/components-schemas-mode" } } }
+ "schema": {
+ "properties": { "mode": { "$ref": "#/components/schemas/components-schemas-mode" } }
+ }
}
},
"required": true
@@ -62330,7 +68466,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_group_response_single" }
+ }
},
"description": "Update a WAF rule group response"
},
@@ -62370,7 +68508,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-response_collection"
+ }
}
},
"description": "List Health Checks response"
@@ -62380,7 +68520,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62406,14 +68548,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Create Health Check response"
@@ -62423,7 +68569,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62451,14 +68599,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Create Preview Health Check response"
@@ -62468,7 +68620,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62506,7 +68660,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-id_response"
+ }
}
},
"description": "Delete Preview Health Check response"
@@ -62551,7 +68707,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Health Check Preview Details response"
@@ -62561,7 +68719,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62599,7 +68759,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-id_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-id_response"
+ }
}
},
"description": "Delete Health Check response"
@@ -62644,7 +68806,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Health Check Details response"
@@ -62654,7 +68818,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62686,14 +68852,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Patch Health Check response"
@@ -62703,7 +68873,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62735,14 +68907,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ }
}
},
"description": "Update Health Check response"
@@ -62752,7 +68928,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/healthchecks_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/healthchecks_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -62782,7 +68960,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/keyless_response_collection" }
+ }
},
"description": "List Keyless SSL Configurations response"
},
@@ -62804,7 +68984,12 @@
"summary": "List Keyless SSL Configurations",
"tags": ["Keyless SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"operationId": "keyless-ssl-for-a-zone-create-keyless-ssl-configuration",
@@ -62824,7 +69009,9 @@
"bundle_method": { "$ref": "#/components/schemas/bundle_method" },
"certificate": { "$ref": "#/components/schemas/schemas-certificate" },
"host": { "$ref": "#/components/schemas/schemas-host" },
- "name": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-name"
+ },
"port": { "$ref": "#/components/schemas/schemas-port" }
},
"required": ["host", "port", "certificate"],
@@ -62836,7 +69023,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/keyless_response_single" }
+ }
+ },
"description": "Create Keyless SSL Configuration response"
},
"4xx": {
@@ -62857,7 +69048,12 @@
"summary": "Create Keyless SSL Configuration",
"tags": ["Keyless SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/keyless_certificates/{identifier}": {
@@ -62868,7 +69064,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -62881,7 +69079,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single_id" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/keyless_response_single_id" }
+ }
},
"description": "Delete Keyless SSL Configuration response"
},
@@ -62903,7 +69103,12 @@
"summary": "Delete Keyless SSL Configuration",
"tags": ["Keyless SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Get details for one Keyless SSL configuration.",
@@ -62913,7 +69118,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -62924,7 +69131,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/keyless_response_single" }
+ }
+ },
"description": "Get Keyless SSL Configuration response"
},
"4xx": {
@@ -62945,7 +69156,12 @@
"summary": "Get Keyless SSL Configuration",
"tags": ["Keyless SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled.",
@@ -62955,7 +69171,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -62971,7 +69189,9 @@
"properties": {
"enabled": { "$ref": "#/components/schemas/schemas-enabled" },
"host": { "$ref": "#/components/schemas/schemas-host" },
- "name": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-name" },
+ "name": {
+ "$ref": "#/components/schemas/keyless-certificate_components-schemas-name"
+ },
"port": { "$ref": "#/components/schemas/schemas-port" }
},
"type": "object"
@@ -62982,7 +69202,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/keyless_response_single" }
+ }
+ },
"description": "Edit Keyless SSL Configuration response"
},
"4xx": {
@@ -63003,7 +69227,12 @@
"summary": "Edit Keyless SSL Configuration",
"tags": ["Keyless SSL for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#ssl:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/datasets/{dataset}/fields": {
@@ -63011,7 +69240,12 @@
"description": "Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.",
"operationId": "logpush-jobs-list-fields",
"parameters": [
- { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } },
+ {
+ "in": "path",
+ "name": "dataset",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/dataset" }
+ },
{
"in": "path",
"name": "zone_identifier",
@@ -63022,7 +69256,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_field_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_field_response_collection" }
+ }
},
"description": "List fields response"
},
@@ -63044,7 +69280,12 @@
"summary": "List fields",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/datasets/{dataset}/jobs": {
@@ -63052,7 +69293,12 @@
"description": "Lists Logpush jobs for a zone for a dataset.",
"operationId": "logpush-jobs-list-logpush-jobs-for-a-dataset",
"parameters": [
- { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } },
+ {
+ "in": "path",
+ "name": "dataset",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/dataset" }
+ },
{
"in": "path",
"name": "zone_identifier",
@@ -63063,7 +69309,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" }
+ }
},
"description": "List Logpush jobs for a dataset response"
},
@@ -63085,7 +69333,12 @@
"summary": "List Logpush jobs for a dataset",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/jobs": {
@@ -63103,7 +69356,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" }
+ }
},
"description": "List Logpush jobs response"
},
@@ -63125,7 +69380,12 @@
"summary": "List Logpush jobs",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates a new Logpush job for a zone.",
@@ -63160,7 +69420,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_job_response_single" }
+ }
},
"description": "Create Logpush job response"
},
@@ -63182,7 +69444,12 @@
"summary": "Create Logpush job",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/jobs/{job_identifier}": {
@@ -63190,7 +69457,12 @@
"description": "Deletes a Logpush job.",
"operationId": "logpush-jobs-delete-logpush-job",
"parameters": [
- { "in": "path", "name": "job_identifier", "required": true, "schema": { "$ref": "#/components/schemas/id" } },
+ {
+ "in": "path",
+ "name": "job_identifier",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/id" }
+ },
{
"in": "path",
"name": "zone_identifier",
@@ -63206,7 +69478,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } }
+ {
+ "properties": {
+ "result": { "example": {}, "nullable": true, "type": "object" }
+ }
+ }
]
}
}
@@ -63221,7 +69497,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/api-response-common" },
- { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } }
+ {
+ "properties": {
+ "result": { "example": {}, "nullable": true, "type": "object" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -63236,13 +69516,23 @@
"summary": "Delete Logpush job",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Gets the details of a Logpush job.",
"operationId": "logpush-jobs-get-logpush-job-details",
"parameters": [
- { "in": "path", "name": "job_identifier", "required": true, "schema": { "$ref": "#/components/schemas/id" } },
+ {
+ "in": "path",
+ "name": "job_identifier",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/id" }
+ },
{
"in": "path",
"name": "zone_identifier",
@@ -63253,7 +69543,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_job_response_single" }
+ }
},
"description": "Get Logpush job details response"
},
@@ -63275,13 +69567,23 @@
"summary": "Get Logpush job details",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a Logpush job.",
"operationId": "logpush-jobs-update-logpush-job",
"parameters": [
- { "in": "path", "name": "job_identifier", "required": true, "schema": { "$ref": "#/components/schemas/id" } },
+ {
+ "in": "path",
+ "name": "job_identifier",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/id" }
+ },
{
"in": "path",
"name": "zone_identifier",
@@ -63308,7 +69610,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/logpush_job_response_single" }
+ }
},
"description": "Update Logpush job response"
},
@@ -63330,7 +69634,12 @@
"summary": "Update Logpush job",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/ownership": {
@@ -63349,7 +69658,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } },
+ "properties": {
+ "destination_conf": { "$ref": "#/components/schemas/destination_conf" }
+ },
"required": ["destination_conf"]
}
}
@@ -63358,7 +69669,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_ownership_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/get_ownership_response" }
+ }
+ },
"description": "Get ownership challenge response"
},
"4xx": {
@@ -63379,7 +69694,12 @@
"summary": "Get ownership challenge",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/ownership/validate": {
@@ -63411,7 +69731,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/validate_ownership_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/validate_ownership_response" }
+ }
},
"description": "Validate ownership challenge response"
},
@@ -63433,7 +69755,12 @@
"summary": "Validate ownership challenge",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/validate/destination/exists": {
@@ -63452,7 +69779,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } },
+ "properties": {
+ "destination_conf": { "$ref": "#/components/schemas/destination_conf" }
+ },
"required": ["destination_conf"]
}
}
@@ -63462,7 +69791,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/destination_exists_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/destination_exists_response" }
+ }
},
"description": "Check destination exists response"
},
@@ -63484,7 +69815,12 @@
"summary": "Check destination exists",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logpush/validate/origin": {
@@ -63503,7 +69839,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "logpull_options": { "$ref": "#/components/schemas/logpull_options" } },
+ "properties": {
+ "logpull_options": { "$ref": "#/components/schemas/logpull_options" }
+ },
"required": ["logpull_options"]
}
}
@@ -63512,7 +69850,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/validate_response" } }
+ },
"description": "Validate origin response"
},
"4xx": {
@@ -63533,7 +69873,12 @@
"summary": "Validate origin",
"tags": ["Logpush Jobs"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logs/control/retention/flag": {
@@ -63550,7 +69895,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } }
+ },
"description": "Get log retention flag response"
},
"4xx": {
@@ -63571,7 +69918,12 @@
"summary": "Get log retention flag",
"tags": ["Logs Received"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Updates log retention flag for Logpull API.",
@@ -63598,7 +69950,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } }
+ },
"description": "Update log retention flag response"
},
"4xx": {
@@ -63619,7 +69973,12 @@
"summary": "Update log retention flag",
"tags": ["Logs Received"],
"x-cfPermissionsRequired": { "enum": ["#logs:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logs/rayids/{ray_identifier}": {
@@ -63642,7 +70001,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logs" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/logs" } }
+ },
"description": "Get logs RayIDs response"
},
"4xx": {
@@ -63663,7 +70024,12 @@
"summary": "Get logs RayIDs",
"tags": ["Logs Received"],
"x-cfPermissionsRequired": { "enum": ["#logs:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logs/received": {
@@ -63680,7 +70046,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logs" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/logs" } }
+ },
"description": "Get logs received response"
},
"4xx": {
@@ -63701,7 +70069,12 @@
"summary": "Get logs received",
"tags": ["Logs Received"],
"x-cfPermissionsRequired": { "enum": ["#logs:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/logs/received/fields": {
@@ -63718,7 +70091,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fields_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/fields_response" } }
+ },
"description": "List fields response"
},
"4xx": {
@@ -63739,7 +70114,12 @@
"summary": "List fields",
"tags": ["Logs Received"],
"x-cfPermissionsRequired": { "enum": ["#logs:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/origin_tls_client_auth": {
@@ -63757,7 +70137,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_collection"
+ }
}
},
"description": "List Certificates response"
@@ -63767,7 +70149,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-certificate_response_collection" },
+ {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -63813,7 +70197,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "Upload Certificate response"
},
@@ -63864,7 +70250,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/hostname_aop_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/hostname_aop_response_collection" }
+ }
},
"description": "Enable or Disable a Hostname for Client Authentication response"
},
@@ -63965,7 +70353,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ }
}
},
"description": "Upload a Hostname Client Certificate response"
@@ -63975,7 +70365,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-certificate_response_single" },
+ {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -64015,7 +70407,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ }
}
},
"description": "Delete Hostname Client Certificate response"
@@ -64025,7 +70419,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-certificate_response_single" },
+ {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -64063,7 +70459,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ }
}
},
"description": "Get the Hostname Client Certificate response"
@@ -64073,7 +70471,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/components-schemas-certificate_response_single" },
+ {
+ "$ref": "#/components/schemas/components-schemas-certificate_response_single"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -64109,7 +70509,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/hostname_aop_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/hostname_aop_single_response" }
+ }
},
"description": "Get the Hostname Status for Client Authentication response"
},
@@ -64148,7 +70550,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } }
+ },
"description": "Get Enablement Setting for Zone response"
},
"4xx": {
@@ -64200,7 +70604,9 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } }
+ },
"description": "Set Enablement for Zone response"
},
"4xx": {
@@ -64232,7 +70638,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -64245,7 +70653,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "Delete Certificate response"
},
@@ -64276,7 +70686,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -64288,7 +70700,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_response_single" }
+ }
},
"description": "Get Certificate Details response"
},
@@ -64328,7 +70742,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_response_collection" }
+ }
},
"description": "List Page Rules response"
},
@@ -64369,7 +70785,9 @@
"schema": {
"properties": {
"actions": { "$ref": "#/components/schemas/schemas-actions" },
- "priority": { "$ref": "#/components/schemas/page-rule_components-schemas-priority" },
+ "priority": {
+ "$ref": "#/components/schemas/page-rule_components-schemas-priority"
+ },
"status": { "$ref": "#/components/schemas/page-rule_components-schemas-status" },
"targets": { "$ref": "#/components/schemas/targets" }
},
@@ -64383,7 +70801,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_response_single" }
+ }
},
"description": "Create a Page Rule response"
},
@@ -64423,7 +70843,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_settings_response_collection" }
+ }
},
"description": "List available Page Rules settings response"
},
@@ -64469,7 +70891,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete a Page Rule response"
},
"4xx": {
@@ -64512,7 +70938,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_response_single" }
+ }
},
"description": "Get a Page Rule response"
},
@@ -64559,7 +70987,9 @@
"schema": {
"properties": {
"actions": { "$ref": "#/components/schemas/schemas-actions" },
- "priority": { "$ref": "#/components/schemas/page-rule_components-schemas-priority" },
+ "priority": {
+ "$ref": "#/components/schemas/page-rule_components-schemas-priority"
+ },
"status": { "$ref": "#/components/schemas/page-rule_components-schemas-status" },
"targets": { "$ref": "#/components/schemas/targets" }
},
@@ -64572,7 +71002,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_response_single" }
+ }
},
"description": "Edit a Page Rule response"
},
@@ -64619,7 +71051,9 @@
"schema": {
"properties": {
"actions": { "$ref": "#/components/schemas/schemas-actions" },
- "priority": { "$ref": "#/components/schemas/page-rule_components-schemas-priority" },
+ "priority": {
+ "$ref": "#/components/schemas/page-rule_components-schemas-priority"
+ },
"status": { "$ref": "#/components/schemas/page-rule_components-schemas-status" },
"targets": { "$ref": "#/components/schemas/targets" }
},
@@ -64633,7 +71067,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/pagerule_response_single" }
+ }
},
"description": "Update a Page Rule response"
},
@@ -64673,7 +71109,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-railgun_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-railgun_response_collection" }
+ }
},
"description": "List available Railguns response"
},
@@ -64695,7 +71133,12 @@
"summary": "List available Railguns",
"tags": ["Railgun Connections for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/railguns/{identifier}": {
@@ -64718,7 +71161,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Railgun details response"
},
"4xx": {
@@ -64739,7 +71186,12 @@
"summary": "Railgun details",
"tags": ["Railgun Connections for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Connect or disconnect a Railgun.",
@@ -64771,7 +71223,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/railgun_response_single" }
+ }
+ },
"description": "Connect or disconnect a Railgun response"
},
"4xx": {
@@ -64792,7 +71248,12 @@
"summary": "Connect or disconnect a Railgun",
"tags": ["Railgun Connections for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/railguns/{identifier}/diagnose": {
@@ -64816,7 +71277,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/test_connection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/test_connection_response" }
+ }
},
"description": "Test Railgun connection response"
},
@@ -64838,7 +71301,12 @@
"summary": "Test Railgun connection",
"tags": ["Railgun Connections for a Zone"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/rate_limits": {
@@ -64856,7 +71324,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ratelimit_response_collection" }
+ }
},
"description": "List rate limits response"
},
@@ -64891,13 +71361,19 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "required": ["match", "threshold", "period", "action"] } } },
+ "content": {
+ "application/json": {
+ "schema": { "required": ["match", "threshold", "period", "action"] }
+ }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ratelimit_response_single" }
+ }
},
"description": "Create a rate limit response"
},
@@ -64950,7 +71426,11 @@
{
"properties": {
"result": {
- "properties": { "id": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } }
+ "properties": {
+ "id": {
+ "$ref": "#/components/schemas/rate-limits_components-schemas-id"
+ }
+ }
}
},
"type": "object"
@@ -64973,7 +71453,9 @@
"properties": {
"result": {
"properties": {
- "id": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" }
+ "id": {
+ "$ref": "#/components/schemas/rate-limits_components-schemas-id"
+ }
}
}
},
@@ -65014,7 +71496,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ratelimit_response_single" }
+ }
},
"description": "Get a rate limit response"
},
@@ -65056,14 +71540,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "required": ["id", "match", "threshold", "period", "action"] } }
+ "application/json": {
+ "schema": { "required": ["id", "match", "threshold", "period", "action"] }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ratelimit_response_single" }
+ }
},
"description": "Update a rate limit response"
},
@@ -65102,7 +71590,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" }
+ }
},
"description": "Get all Zone settings response"
},
@@ -65163,7 +71653,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" }
+ }
},
"description": "Edit zone settings info response"
},
@@ -65335,7 +71827,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/advanced_ddos" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/advanced_ddos" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65350,7 +71846,12 @@
"summary": "Get Advanced DDOS setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/always_online": {
@@ -65387,7 +71888,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_online" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_online" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65448,7 +71953,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_online" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_online" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65485,7 +71994,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_use_https" }
+ }
+ }
]
}
}
@@ -65500,7 +72013,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_use_https" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65532,7 +72049,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/always_use_https_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/always_use_https_value" }
+ },
"required": ["value"]
}
}
@@ -65546,7 +72065,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_use_https" }
+ }
+ }
]
}
}
@@ -65561,7 +72084,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/always_use_https" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65598,7 +72125,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_https_rewrites" }
+ }
+ }
]
}
}
@@ -65613,7 +72144,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_https_rewrites" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65645,7 +72180,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/automatic_https_rewrites_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/automatic_https_rewrites_value" }
+ },
"required": ["value"]
}
}
@@ -65659,7 +72196,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_https_rewrites" }
+ }
+ }
]
}
}
@@ -65674,7 +72215,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_https_rewrites" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65711,7 +72256,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_platform_optimization" }
+ }
+ }
]
}
}
@@ -65727,7 +72276,11 @@
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
{
- "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } }
+ "properties": {
+ "result": {
+ "$ref": "#/components/schemas/automatic_platform_optimization"
+ }
+ }
}
]
},
@@ -65760,7 +72313,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/automatic_platform_optimization" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/automatic_platform_optimization" }
+ },
"required": ["value"]
}
}
@@ -65774,7 +72329,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/automatic_platform_optimization" }
+ }
+ }
]
}
}
@@ -65790,7 +72349,11 @@
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
{
- "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } }
+ "properties": {
+ "result": {
+ "$ref": "#/components/schemas/automatic_platform_optimization"
+ }
+ }
}
]
},
@@ -65941,7 +72504,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_cache_ttl" }
+ }
+ }
]
}
}
@@ -65956,7 +72523,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_cache_ttl" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -65988,7 +72559,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/browser_cache_ttl_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/browser_cache_ttl_value" }
+ },
"required": ["value"]
}
}
@@ -66002,7 +72575,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_cache_ttl" }
+ }
+ }
]
}
}
@@ -66017,7 +72594,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_cache_ttl" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66069,7 +72650,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_check" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_check" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66130,7 +72715,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/browser_check" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/browser_check" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66182,7 +72771,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/cache_level" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/cache_level" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66243,7 +72834,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/cache_level" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/cache_level" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66295,7 +72888,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/challenge_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/challenge_ttl" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66356,7 +72953,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/challenge_ttl" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/challenge_ttl" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66506,7 +73107,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/development_mode" }
+ }
+ }
]
}
}
@@ -66521,7 +73126,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/development_mode" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66553,7 +73162,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/development_mode_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/development_mode_value" }
+ },
"required": ["value"]
}
}
@@ -66567,7 +73178,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/development_mode" }
+ }
+ }
]
}
}
@@ -66582,7 +73197,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/development_mode" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66634,7 +73253,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/early_hints" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/early_hints" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66695,7 +73316,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/early_hints" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/early_hints" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66732,7 +73355,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/email_obfuscation" }
+ }
+ }
]
}
}
@@ -66747,7 +73374,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/email_obfuscation" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66779,7 +73410,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/email_obfuscation_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/email_obfuscation_value" }
+ },
"required": ["value"]
}
}
@@ -66793,7 +73426,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/email_obfuscation" }
+ }
+ }
]
}
}
@@ -66808,7 +73445,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/email_obfuscation" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66845,7 +73486,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/h2_prioritization" }
+ }
+ }
]
}
}
@@ -66860,7 +73505,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/h2_prioritization" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66892,7 +73541,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/h2_prioritization_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/h2_prioritization_value" }
+ },
"required": ["value"]
}
}
@@ -66906,7 +73557,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/h2_prioritization" }
+ }
+ }
]
}
}
@@ -66921,7 +73576,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/h2_prioritization" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -66958,7 +73617,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/hotlink_protection" }
+ }
+ }
]
}
}
@@ -66973,7 +73636,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/hotlink_protection" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67005,7 +73672,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/hotlink_protection_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/hotlink_protection_value" }
+ },
"required": ["value"]
}
}
@@ -67019,7 +73688,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/hotlink_protection" }
+ }
+ }
]
}
}
@@ -67034,7 +73707,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/hotlink_protection" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67297,7 +73974,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } }
+ }
]
}
}
@@ -67312,7 +73991,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/image_resizing" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67327,7 +74010,12 @@
"summary": "Get Image Resizing setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.",
@@ -67358,7 +74046,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } }
+ }
]
}
}
@@ -67373,7 +74063,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/image_resizing" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67388,7 +74082,12 @@
"summary": "Change Image Resizing setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/ip_geolocation": {
@@ -67410,7 +74109,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } }
+ }
]
}
}
@@ -67425,7 +74126,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/ip_geolocation" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67471,7 +74176,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } }
+ }
]
}
}
@@ -67486,7 +74193,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/ip_geolocation" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67636,7 +74347,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } }
+ }
]
}
}
@@ -67651,7 +74364,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/min_tls_version" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67697,7 +74414,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } }
+ }
]
}
}
@@ -67712,7 +74431,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/min_tls_version" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -67975,7 +74698,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } }
+ }
]
}
}
@@ -67990,7 +74715,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/mobile_redirect" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68036,7 +74765,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } }
+ }
]
}
}
@@ -68051,7 +74782,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/mobile_redirect" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68201,7 +74936,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_encryption" }
+ }
+ }
]
}
}
@@ -68216,7 +74955,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_encryption" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68248,7 +74991,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/opportunistic_encryption_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/opportunistic_encryption_value" }
+ },
"required": ["value"]
}
}
@@ -68262,7 +75007,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_encryption" }
+ }
+ }
]
}
}
@@ -68277,7 +75026,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_encryption" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68314,7 +75067,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_onion" }
+ }
+ }
]
}
}
@@ -68329,7 +75086,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_onion" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68361,7 +75122,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/opportunistic_onion_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/opportunistic_onion_value" }
+ },
"required": ["value"]
}
}
@@ -68375,7 +75138,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_onion" }
+ }
+ }
]
}
}
@@ -68390,7 +75157,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/opportunistic_onion" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68427,7 +75198,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/orange_to_orange" }
+ }
+ }
]
}
}
@@ -68442,7 +75217,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/orange_to_orange" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68457,7 +75236,12 @@
"summary": "Get Orange to Orange (O2O)",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.",
@@ -68474,7 +75258,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/orange_to_orange_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/orange_to_orange_value" }
+ },
"required": ["value"]
}
}
@@ -68488,7 +75274,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/orange_to_orange" }
+ }
+ }
]
}
}
@@ -68503,7 +75293,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/orange_to_orange" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68518,7 +75312,12 @@
"summary": "Change Orange to Orange (O2O)",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/origin_error_page_pass_thru": {
@@ -68540,7 +75339,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" }
+ }
+ }
]
}
}
@@ -68555,7 +75358,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68570,7 +75377,12 @@
"summary": "Get Enable Error Pages On setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.",
@@ -68587,7 +75399,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/origin_error_page_pass_thru_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/origin_error_page_pass_thru_value" }
+ },
"required": ["value"]
}
}
@@ -68601,7 +75415,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" }
+ }
+ }
]
}
}
@@ -68616,7 +75434,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68631,7 +75453,12 @@
"summary": "Change Enable Error Pages On setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/origin_max_http_version": {
@@ -68700,7 +75527,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/origin_max_http_version_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/origin_max_http_version_value" }
+ },
"required": ["value"]
}
}
@@ -68879,7 +75708,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/prefetch_preload" }
+ }
+ }
]
}
}
@@ -68894,7 +75727,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/prefetch_preload" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68909,7 +75746,12 @@
"summary": "Get prefetch preload setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.",
@@ -68926,7 +75768,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/prefetch_preload_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/prefetch_preload_value" }
+ },
"required": ["value"]
}
}
@@ -68940,7 +75784,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/prefetch_preload" }
+ }
+ }
]
}
}
@@ -68955,7 +75803,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/prefetch_preload" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -68970,7 +75822,12 @@
"summary": "Change prefetch preload setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/privacy_pass": {
@@ -69007,7 +75864,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/privacy_pass" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/privacy_pass" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69068,7 +75929,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/privacy_pass" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/privacy_pass" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69105,7 +75970,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/proxy_read_timeout" }
+ }
+ }
]
}
}
@@ -69120,7 +75989,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/proxy_read_timeout" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69135,7 +76008,12 @@
"summary": "Get Proxy Read Timeout setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Maximum time between two read operations from origin.",
@@ -69152,7 +76030,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/proxy_read_timeout_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/proxy_read_timeout_value" }
+ },
"required": ["value"]
}
}
@@ -69166,7 +76046,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/proxy_read_timeout" }
+ }
+ }
]
}
}
@@ -69181,7 +76065,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/proxy_read_timeout" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69196,7 +76084,12 @@
"summary": "Change Proxy Read Timeout setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/pseudo_ipv4": {
@@ -69233,7 +76126,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69294,7 +76189,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69331,7 +76228,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/response_buffering" }
+ }
+ }
]
}
}
@@ -69346,7 +76247,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/response_buffering" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69361,7 +76266,12 @@
"summary": "Get Response Buffering setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.",
@@ -69378,7 +76288,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/response_buffering_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/response_buffering_value" }
+ },
"required": ["value"]
}
}
@@ -69392,7 +76304,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/response_buffering" }
+ }
+ }
]
}
}
@@ -69407,7 +76323,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/response_buffering" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69422,7 +76342,12 @@
"summary": "Change Response Buffering setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/rocket_loader": {
@@ -69459,7 +76384,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/rocket_loader" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/rocket_loader" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69520,7 +76449,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/rocket_loader" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/rocket_loader" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69557,7 +76490,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/security_header" } }
+ }
]
}
}
@@ -69572,7 +76507,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/security_header" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69618,7 +76557,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/security_header" } }
+ }
]
}
}
@@ -69633,7 +76574,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/security_header" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69670,7 +76615,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/security_level" } }
+ }
]
}
}
@@ -69685,7 +76632,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/security_level" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69731,7 +76682,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/security_level" } }
+ }
]
}
}
@@ -69746,7 +76699,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/security_level" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69783,7 +76740,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/server_side_exclude" }
+ }
+ }
]
}
}
@@ -69798,7 +76759,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/server_side_exclude" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69830,7 +76795,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/server_side_exclude_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/server_side_exclude_value" }
+ },
"required": ["value"]
}
}
@@ -69844,7 +76811,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/server_side_exclude" }
+ }
+ }
]
}
}
@@ -69859,7 +76830,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/server_side_exclude" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69896,7 +76871,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" }
+ }
+ }
]
}
}
@@ -69911,7 +76890,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69926,7 +76909,12 @@
"summary": "Get Enable Query String Sort setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.",
@@ -69943,7 +76931,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/sort_query_string_for_cache_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/sort_query_string_for_cache_value" }
+ },
"required": ["value"]
}
}
@@ -69957,7 +76947,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" }
+ }
+ }
]
}
}
@@ -69972,7 +76966,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -69987,7 +76985,12 @@
"summary": "Change Enable Query String Sort setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/ssl": {
@@ -70122,7 +77125,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } }
+ }
]
}
}
@@ -70137,7 +77142,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/ssl_recommender" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70169,7 +77178,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "enabled": { "$ref": "#/components/schemas/ssl_recommender_enabled" } },
+ "properties": {
+ "enabled": { "$ref": "#/components/schemas/ssl_recommender_enabled" }
+ },
"required": ["enabled"]
}
}
@@ -70183,7 +77194,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } }
+ }
]
}
}
@@ -70198,7 +77211,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/ssl_recommender" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70348,7 +77365,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } }
+ }
]
}
}
@@ -70363,7 +77382,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/tls_client_auth" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70378,7 +77401,12 @@
"summary": "Get TLS Client Auth setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).",
@@ -70409,7 +77437,9 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } }
+ }
]
}
}
@@ -70424,7 +77454,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/tls_client_auth" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70439,7 +77473,12 @@
"summary": "Change TLS Client Auth setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/true_client_ip_header": {
@@ -70461,7 +77500,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/true_client_ip_header" }
+ }
+ }
]
}
}
@@ -70476,7 +77519,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/true_client_ip_header" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70491,7 +77538,12 @@
"summary": "Get True Client IP setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.",
@@ -70508,7 +77560,9 @@
"content": {
"application/json": {
"schema": {
- "properties": { "value": { "$ref": "#/components/schemas/true_client_ip_header_value" } },
+ "properties": {
+ "value": { "$ref": "#/components/schemas/true_client_ip_header_value" }
+ },
"required": ["value"]
}
}
@@ -70522,7 +77576,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/true_client_ip_header" }
+ }
+ }
]
}
}
@@ -70537,7 +77595,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/true_client_ip_header" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70552,7 +77614,12 @@
"summary": "Change True Client IP setting",
"tags": ["Zone Settings"],
"x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/settings/waf": {
@@ -70815,7 +77882,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/websockets" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/websockets" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70876,7 +77945,9 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/websockets" } } }
+ {
+ "properties": { "result": { "$ref": "#/components/schemas/websockets" } }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -70909,7 +77980,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_pack_response_collection" }
+ }
},
"description": "List Certificate Packs response"
},
@@ -70958,7 +78031,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_pack_response_single" }
+ }
},
"description": "Order Certificate Pack response"
},
@@ -71007,7 +78082,13 @@
"validation_method": { "$ref": "#/components/schemas/validation_method" },
"validity_days": { "$ref": "#/components/schemas/validity_days" }
},
- "required": ["type", "hosts", "validation_method", "validity_days", "certificate_authority"],
+ "required": [
+ "type",
+ "hosts",
+ "validation_method",
+ "validity_days",
+ "certificate_authority"
+ ],
"type": "object"
}
}
@@ -71018,7 +78099,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/advanced_certificate_pack_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/advanced_certificate_pack_response_single"
+ }
}
},
"description": "Order Advanced Certificate Manager Certificate Pack response"
@@ -71059,7 +78142,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_quota_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_pack_quota_response" }
+ }
},
"description": "Get Certificate Pack Quotas response"
},
@@ -71093,7 +78178,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -71107,7 +78194,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single"
+ }
}
},
"description": "Delete Advanced Certificate Manager Certificate Pack response"
@@ -71117,7 +78206,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single" },
+ {
+ "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71140,7 +78231,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -71152,7 +78245,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_response_single" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/certificate_pack_response_single" }
+ }
},
"description": "Get Certificate Pack response"
},
@@ -71184,7 +78279,9 @@
"in": "path",
"name": "identifier",
"required": true,
- "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" }
+ "schema": {
+ "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier"
+ }
},
{
"in": "path",
@@ -71198,7 +78295,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/advanced_certificate_pack_response_single" }
+ "schema": {
+ "$ref": "#/components/schemas/advanced_certificate_pack_response_single"
+ }
}
},
"description": "Restart Validation for Advanced Certificate Manager Certificate Pack response"
@@ -71311,7 +78410,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" }
+ }
},
"description": "Universal SSL Settings Details response"
},
@@ -71347,13 +78448,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/universal" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/universal" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" }
+ }
},
"description": "Edit Universal SSL Settings response"
},
@@ -71393,7 +78498,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/ssl_verification_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ssl_verification_response_collection" }
+ }
},
"description": "SSL Verification Details response"
},
@@ -71438,7 +78545,9 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-validation_method" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-validation_method" }
+ }
},
"required": true
},
@@ -71446,7 +78555,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/ssl_validation_method_response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/ssl_validation_method_response_collection"
+ }
}
},
"description": "Edit SSL Certificate Pack Validation Method response"
@@ -71488,7 +78599,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/waitingroom_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-response_collection"
+ }
}
},
"description": "List waiting rooms response"
@@ -71498,7 +78611,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/waitingroom_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71510,7 +78625,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List waiting rooms",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Creates a new waiting room.",
@@ -71524,14 +78644,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ }
}
},
"description": "Create waiting room response"
@@ -71541,7 +78665,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71553,7 +78679,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create waiting room",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/preview": {
@@ -71569,13 +78700,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_preview" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_preview" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-preview_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-preview_response" }
+ }
},
"description": "Create a custom waiting room page preview response"
},
@@ -71596,7 +78731,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create a custom waiting room page preview",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}": {
@@ -71621,7 +78761,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/waiting_room_id_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/waiting_room_id_response" }
+ }
},
"description": "Delete waiting room response"
},
@@ -71642,7 +78784,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete waiting room",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Fetches a single configured waiting room.",
@@ -71665,7 +78812,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ }
}
},
"description": "Waiting room details response"
@@ -71675,7 +78824,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71687,7 +78838,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Waiting room details",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Patches a configured waiting room.",
@@ -71707,14 +78863,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ }
}
},
"description": "Patch waiting room response"
@@ -71724,7 +78884,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71736,7 +78898,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Patch waiting room",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a configured waiting room.",
@@ -71756,14 +78923,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ }
}
},
"description": "Update waiting room response"
@@ -71773,7 +78944,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/waitingroom_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/waitingroom_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -71785,7 +78958,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update waiting room",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events": {
@@ -71809,7 +78987,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/event_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/event_response_collection" }
+ }
},
"description": "List events response"
},
@@ -71830,7 +79010,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List events",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.",
@@ -71850,12 +79035,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } }
+ },
"description": "Create event response"
},
"4xx": {
@@ -71875,7 +79064,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create event",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}": {
@@ -71883,7 +79077,12 @@
"description": "Deletes an event for a waiting room.",
"operationId": "waiting-room-delete-event",
"parameters": [
- { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } },
+ {
+ "in": "path",
+ "name": "event_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/event_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -71900,7 +79099,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_id_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/event_id_response" } }
+ },
"description": "Delete event response"
},
"4xx": {
@@ -71920,13 +79121,23 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete event",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"description": "Fetches a single configured event for a waiting room.",
"operationId": "waiting-room-event-details",
"parameters": [
- { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } },
+ {
+ "in": "path",
+ "name": "event_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/event_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -71942,7 +79153,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } }
+ },
"description": "Event details response"
},
"4xx": {
@@ -71962,13 +79175,23 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Event details",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Patches a configured event for a waiting room.",
"operationId": "waiting-room-patch-event",
"parameters": [
- { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } },
+ {
+ "in": "path",
+ "name": "event_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/event_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -71983,12 +79206,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } }
+ },
"description": "Patch event response"
},
"4xx": {
@@ -72008,13 +79235,23 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Patch event",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Updates a configured event for a waiting room.",
"operationId": "waiting-room-update-event",
"parameters": [
- { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } },
+ {
+ "in": "path",
+ "name": "event_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/event_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -72029,12 +79266,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } }
+ },
"description": "Update event response"
},
"4xx": {
@@ -72054,7 +79295,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update event",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details": {
@@ -72062,7 +79308,12 @@
"description": "Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.",
"operationId": "waiting-room-preview-active-event-details",
"parameters": [
- { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } },
+ {
+ "in": "path",
+ "name": "event_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/event_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -72078,7 +79329,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_details_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/event_details_response" }
+ }
+ },
"description": "Preview active event details response"
},
"4xx": {
@@ -72098,7 +79353,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Preview active event details",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules": {
@@ -72122,7 +79382,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" }
+ }
},
"description": "List Waiting Room Rules response"
},
@@ -72143,7 +79405,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Waiting Room Rules",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.",
@@ -72163,13 +79430,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_rule" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" }
+ }
},
"description": "Create Waiting Room Rule response"
},
@@ -72190,7 +79461,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Waiting Room Rule",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"description": "Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.",
@@ -72210,13 +79486,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_rules" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_rules" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" }
+ }
},
"description": "Replace Waiting Room Rules response"
},
@@ -72237,7 +79517,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Replace Waiting Room Rules",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}": {
@@ -72245,7 +79530,12 @@
"description": "Deletes a rule for a waiting room.",
"operationId": "waiting-room-delete-waiting-room-rule",
"parameters": [
- { "in": "path", "name": "rule_id", "required": true, "schema": { "$ref": "#/components/schemas/rule_id" } },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/rule_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -72263,7 +79553,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" }
+ }
},
"description": "Delete Waiting Room Rule response"
},
@@ -72284,13 +79576,23 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Waiting Room Rule",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"patch": {
"description": "Patches a rule for a waiting room.",
"operationId": "waiting-room-patch-waiting-room-rule",
"parameters": [
- { "in": "path", "name": "rule_id", "required": true, "schema": { "$ref": "#/components/schemas/rule_id" } },
+ {
+ "in": "path",
+ "name": "rule_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/rule_id" }
+ },
{
"in": "path",
"name": "waiting_room_id",
@@ -72305,13 +79607,17 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/patch_rule" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-rules_response_collection" }
+ }
},
"description": "Patch Waiting Room Rule response"
},
@@ -72332,7 +79638,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Patch Waiting Room Rule",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status": {
@@ -72355,7 +79666,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/status_response" } }
+ },
"description": "Get waiting room status response"
},
"4xx": {
@@ -72375,7 +79688,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get waiting room status",
"tags": ["Waiting Room"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/web3/hostnames": {
@@ -72428,14 +79746,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_request" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_request" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ }
}
},
"description": "Create Web3 Hostname response"
@@ -72445,7 +79767,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -72480,7 +79804,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete Web3 Hostname response"
},
"4xx": {
@@ -72522,7 +79850,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ }
}
},
"description": "Web3 Hostname Details response"
@@ -72532,7 +79862,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -72563,14 +79895,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modify_request" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/modify_request" } }
+ },
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }
+ "schema": {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ }
}
},
"description": "Edit Web3 Hostname response"
@@ -72580,7 +79916,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" },
+ {
+ "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -72615,7 +79953,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_details_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_details_response" }
+ }
},
"description": "IPFS Universal Path Gateway Content List Details response"
},
@@ -72636,7 +79976,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "IPFS Universal Path Gateway Content List Details",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"operationId": "web3-hostname-update-ipfs-universal-path-gateway-content-list",
@@ -72656,14 +80001,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_update_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_update_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_details_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_details_response" }
+ }
},
"description": "Update IPFS Universal Path Gateway Content List response"
},
@@ -72684,7 +80033,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update IPFS Universal Path Gateway Content List",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries": {
@@ -72730,7 +80084,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List IPFS Universal Path Gateway Content List Entries",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"operationId": "web3-hostname-create-ipfs-universal-path-gateway-content-list-entry",
@@ -72750,14 +80109,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" }
+ }
},
"description": "Create IPFS Universal Path Gateway Content List Entry response"
},
@@ -72778,7 +80141,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create IPFS Universal Path Gateway Content List Entry",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}": {
@@ -72807,7 +80175,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete IPFS Universal Path Gateway Content List Entry response"
},
"4xx": {
@@ -72827,7 +80199,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete IPFS Universal Path Gateway Content List Entry",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"operationId": "web3-hostname-ipfs-universal-path-gateway-content-list-entry-details",
@@ -72854,7 +80231,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" }
+ }
},
"description": "IPFS Universal Path Gateway Content List Entry Details response"
},
@@ -72875,7 +80254,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "IPFS Universal Path Gateway Content List Entry Details",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"operationId": "web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry",
@@ -72901,14 +80285,18 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" }
+ }
},
"required": true
},
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" }
+ }
},
"description": "Edit IPFS Universal Path Gateway Content List Entry response"
},
@@ -72929,7 +80317,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Edit IPFS Universal Path Gateway Content List Entry",
"tags": ["Web3 Hostname"],
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_identifier}/workers/script": {
@@ -72948,12 +80341,17 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": { "content": { "application/json": {} }, "description": "Delete Worker response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete Worker response failure" }
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete Worker response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Worker",
"tags": ["Worker Script (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation"
+ }
},
"get": {
"deprecated": true,
@@ -72992,7 +80390,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Download Worker",
"tags": ["Worker Script (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation"
+ }
},
"put": {
"deprecated": true,
@@ -73018,7 +80418,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/script-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/script-response-single" }
+ }
+ },
"description": "Upload Worker response"
},
"4xx": {
@@ -73038,7 +80442,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Upload Worker",
"tags": ["Worker Script (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/scripts/x-cfDeprecations/worker_script_deprecation"
+ }
}
},
"/zones/{zone_identifier}/workers/script/bindings": {
@@ -73063,7 +80469,10 @@
{ "$ref": "#/components/schemas/api-response-common" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/binding" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/binding" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -73083,7 +80492,10 @@
{ "$ref": "#/components/schemas/api-response-common" },
{
"properties": {
- "result": { "items": { "$ref": "#/components/schemas/binding" }, "type": "array" }
+ "result": {
+ "items": { "$ref": "#/components/schemas/binding" },
+ "type": "array"
+ }
},
"type": "object"
}
@@ -73100,7 +80512,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Bindings",
"tags": ["Worker Binding (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/bindings/x-cfDeprecations/worker_binding_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/bindings/x-cfDeprecations/worker_binding_deprecation"
+ }
}
},
"/zones/{zone_id}/activation_check": {
@@ -73141,7 +80555,9 @@
"4xx": {
"content": {
"application/json": {
- "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] }
+ "schema": {
+ "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }]
+ }
}
},
"description": "Client Error"
@@ -73164,7 +80580,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/single_response" } }
+ },
"description": "Retrieve information about specific configuration properties response"
},
"4xx": {
@@ -73185,7 +80603,12 @@
"summary": "Retrieve information about specific configuration properties",
"tags": ["API Shield Settings"],
"x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"put": {
"operationId": "api-shield-settings-set-configuration-properties",
@@ -73198,12 +80621,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configuration" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/configuration" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } }
+ },
"description": "Set configuration properties response"
},
"4xx": {
@@ -73223,8 +80650,15 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Set configuration properties",
"tags": ["API Shield Settings"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.update"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.api-gateway.update"]
+ },
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/api_gateway/discovery": {
@@ -73242,7 +80676,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schema_response_discovery" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schema_response_discovery" }
+ }
},
"description": "Retrieve API Discovery results for a zone response"
},
@@ -73264,7 +80700,12 @@
"summary": "Retrieve API Discovery results for a zone",
"tags": ["API Shield Endpoint Management"],
"x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/api_gateway/operations": {
@@ -73281,7 +80722,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/collection_response_paginated" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_response_paginated" }
+ }
},
"description": "Retrieve information about all operations on a zone response"
},
@@ -73303,7 +80746,12 @@
"summary": "Retrieve information about all operations on a zone",
"tags": ["API Shield Endpoint Management"],
"x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"post": {
"description": "Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.",
@@ -73337,7 +80785,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/collection_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/collection_response" }
+ }
+ },
"description": "Add operations to a zone response"
},
"4xx": {
@@ -73357,8 +80809,15 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Add operations to a zone",
"tags": ["API Shield Endpoint Management"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.create"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.api-gateway.create"]
+ },
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/api_gateway/operations/{operation_id}": {
@@ -73381,7 +80840,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } }
+ },
"description": "Delete an operation response"
},
"4xx": {
@@ -73401,8 +80862,15 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete an operation",
"tags": ["API Shield Endpoint Management"],
- "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.delete"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPermissionsRequired": {
+ "enum": ["com.cloudflare.api.account.zone.api-gateway.delete"]
+ },
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
},
"get": {
"operationId": "api-shield-endpoint-management-retrieve-information-about-an-operation",
@@ -73422,7 +80890,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-single_response" }
+ }
+ },
"description": "Retrieve information about an operation response"
},
"4xx": {
@@ -73443,7 +80915,12 @@
"summary": "Retrieve information about an operation",
"tags": ["API Shield Endpoint Management"],
"x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/api_gateway/schemas": {
@@ -73460,7 +80937,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/schema_response_with_thresholds" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schema_response_with_thresholds" }
+ }
},
"description": "Retrieve operations and features as OpenAPI schemas response"
},
@@ -73482,7 +80961,12 @@
"summary": "Retrieve operations and features as OpenAPI schemas",
"tags": ["API Shield Endpoint Management"],
"x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] },
- "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": false,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/firewall/access_rules/rules": {
@@ -73500,7 +80984,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_collection_response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_collection_response" }
+ }
},
"description": "List IP Access rules response"
},
@@ -73551,7 +81037,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_response" }
+ }
+ },
"description": "Create an IP Access rule response"
},
"4xx": {
@@ -73611,7 +81101,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_id_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_id_response" }
+ }
+ },
"description": "Delete an IP Access rule response"
},
"4xx": {
@@ -73665,7 +81159,11 @@
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_single_response" }
+ }
+ },
"description": "Update an IP Access rule response"
},
"4xx": {
@@ -73709,7 +81207,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_collection" }
+ }
},
"description": "List WAF rules response"
},
@@ -73759,7 +81259,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/rule_response_single" }
+ }
+ },
"description": "Get a WAF rule response"
},
"4xx": {
@@ -74017,7 +81521,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/get-zone-settings-response" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/get-zone-settings-response" }
+ }
+ }
]
}
}
@@ -74032,7 +81540,11 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/get-zone-settings-response" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/get-zone-settings-response" }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -74064,11 +81576,15 @@
"application/json": {
"schema": {
"properties": {
- "enabled": { "$ref": "#/components/schemas/script-monitor_components-schemas-enabled" },
+ "enabled": {
+ "$ref": "#/components/schemas/script-monitor_components-schemas-enabled"
+ },
"use_cloudflare_reporting_endpoint": {
"$ref": "#/components/schemas/use_cloudflare_reporting_endpoint"
},
- "use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" }
+ "use_connection_url_path": {
+ "$ref": "#/components/schemas/use_connection_url_path"
+ }
}
}
}
@@ -74082,7 +81598,11 @@
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/update-zone-settings-response" } } }
+ {
+ "properties": {
+ "result": { "$ref": "#/components/schemas/update-zone-settings-response" }
+ }
+ }
]
}
}
@@ -74097,7 +81617,13 @@
{
"allOf": [
{ "$ref": "#/components/schemas/zone_settings_response_single" },
- { "properties": { "result": { "$ref": "#/components/schemas/update-zone-settings-response" } } }
+ {
+ "properties": {
+ "result": {
+ "$ref": "#/components/schemas/update-zone-settings-response"
+ }
+ }
+ }
]
},
{ "$ref": "#/components/schemas/api-response-common-failure" }
@@ -74129,7 +81655,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-zone-connections-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-zone-connections-response" }
+ }
},
"description": "List Page Shield connections response"
},
@@ -74150,7 +81678,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Page Shield connections",
"tags": ["Page Shield"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/page_shield/connections/{id}": {
@@ -74174,7 +81707,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/get-zone-connection-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/get-zone-connection-response" }
+ }
},
"description": "Get a Page Shield connection response"
},
@@ -74195,7 +81730,12 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Get a Page Shield connection",
"tags": ["Page Shield"],
- "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false }
+ "x-cfPlanAvailability": {
+ "business": true,
+ "enterprise": true,
+ "free": false,
+ "pro": false
+ }
}
},
"/zones/{zone_id}/page_shield/scripts": {
@@ -74213,7 +81753,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/list-zone-scripts-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/list-zone-scripts-response" }
+ }
},
"description": "List Page Shield scripts response"
},
@@ -74258,7 +81800,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/get-zone-script-response" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/get-zone-script-response" }
+ }
},
"description": "Get a Page Shield script response"
},
@@ -74296,7 +81840,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List zone rulesets response"
},
"4xx": {
@@ -74330,12 +81876,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Create a zone ruleset response"
},
"4xx": {
@@ -74373,7 +81923,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-ruleset" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/components-schemas-ruleset" }
+ }
},
"description": "Get Custom Error Responses response"
},
@@ -74408,12 +81960,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Update Custom Error Responses response"
},
"4xx": {
@@ -74456,7 +82014,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/schemas-ruleset" } }
+ },
"description": "List Transform Rules response"
},
"4xx": {
@@ -74496,12 +82056,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Update Transform Rules response"
},
"4xx": {
@@ -74544,7 +82110,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get a zone entry point ruleset response"
},
"4xx": {
@@ -74584,12 +82152,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update a zone entry point ruleset response"
},
"4xx": {
@@ -74632,7 +82204,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List a zone entry point ruleset's versions response"
},
"4xx": {
@@ -74681,7 +82255,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get a zone entry point ruleset version response"
},
"4xx": {
@@ -74724,8 +82300,14 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete a zone ruleset response" },
- "4xx": { "content": { "application/json": {} }, "description": "Delete a zone ruleset response failure" }
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete a zone ruleset response"
+ },
+ "4xx": {
+ "content": { "application/json": {} },
+ "description": "Delete a zone ruleset response failure"
+ }
},
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete a zone ruleset",
@@ -74751,7 +82333,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get a zone ruleset response"
},
"4xx": {
@@ -74791,12 +82375,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update a zone ruleset response"
},
"4xx": {
@@ -74838,12 +82426,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Create a zone ruleset rule response"
},
"4xx": {
@@ -74893,7 +82485,9 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Delete a zone ruleset rule response"
},
"4xx": {
@@ -74939,12 +82533,16 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Update a zone ruleset rule response"
},
"4xx": {
@@ -74987,7 +82585,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } }
+ },
"description": "List a zone ruleset's versions response"
},
"4xx": {
@@ -75036,7 +82636,10 @@
],
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
- "200": { "content": { "application/json": {} }, "description": "Delete a zone ruleset version response" },
+ "200": {
+ "content": { "application/json": {} },
+ "description": "Delete a zone ruleset version response"
+ },
"4xx": {
"content": { "application/json": {} },
"description": "Delete a zone ruleset version response failure"
@@ -75072,7 +82675,9 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } }
+ },
"description": "Get a zone ruleset version response"
},
"4xx": {
@@ -75109,7 +82714,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_model" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_model" }
+ }
+ },
"description": "Get URL normalization settings response"
},
"4xx": {
@@ -75143,12 +82752,20 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-request_model" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-request_model" }
+ }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_model" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_model" }
+ }
+ },
"description": "Update URL normalization settings response"
},
"4xx": {
@@ -75186,7 +82803,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/filter-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-response-collection" }
+ }
},
"description": "List Filters response"
},
@@ -75207,7 +82826,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "List Filters",
"tags": ["Worker Filters (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation"
+ }
},
"post": {
"deprecated": true,
@@ -75221,12 +82842,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Create Filter response"
},
"4xx": {
@@ -75246,7 +82873,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Create Filter",
"tags": ["Worker Filters (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation"
+ }
}
},
"/zones/{zone_id}/workers/filters/{filter_id}": {
@@ -75270,7 +82899,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete Filter response"
},
"4xx": {
@@ -75290,7 +82923,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Delete Filter",
"tags": ["Worker Filters (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation"
+ }
},
"put": {
"deprecated": true,
@@ -75310,12 +82945,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/filter-response-single" }
+ }
+ },
"description": "Update Filter response"
},
"4xx": {
@@ -75335,7 +82976,9 @@
"security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }],
"summary": "Update Filter",
"tags": ["Worker Filters (Deprecated)"],
- "x-cfDeprecation": { "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation" }
+ "x-cfDeprecation": {
+ "$ref": "#/components/schemas/filters/x-cfDeprecations/worker_filter_deprecation"
+ }
}
},
"/zones/{zone_id}/workers/routes": {
@@ -75352,7 +82995,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/route-response-collection" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route-response-collection" }
+ }
},
"description": "List Routes response"
},
@@ -75386,12 +83031,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Create Route response"
},
"4xx": {
@@ -75434,7 +83085,11 @@
"requestBody": { "content": { "application/json": {} }, "required": true },
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single-id" }
+ }
+ },
"description": "Delete Route response"
},
"4xx": {
@@ -75474,7 +83129,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route-response-single" }
+ }
+ },
"description": "Get Route response"
},
"4xx": {
@@ -75513,12 +83172,18 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } }
+ },
"required": true
},
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/route-response-single" }
+ }
+ },
"description": "Update Route response"
},
"4xx": {
@@ -75557,7 +83222,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection"
+ }
}
},
"description": "Get current aggregated analytics response"
@@ -75567,7 +83234,9 @@
"application/json": {
"schema": {
"allOf": [
- { "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection" },
+ {
+ "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection"
+ },
{ "$ref": "#/components/schemas/api-response-common-failure" }
]
}
@@ -75595,7 +83264,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Get analytics by time response"
},
"4xx": {
@@ -75631,7 +83304,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/api-response-single" }
+ }
+ },
"description": "Get analytics summary response"
},
"4xx": {
@@ -75669,7 +83346,9 @@
"200": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/app_components-schemas-response_collection" }
+ "schema": {
+ "$ref": "#/components/schemas/app_components-schemas-response_collection"
+ }
}
},
"description": "List Spectrum applications response"
@@ -75729,7 +83408,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/response_single_origin_dns" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_single_origin_dns" }
+ }
},
"description": "Create Spectrum application using a name for the origin response"
},
@@ -75757,7 +83438,12 @@
"description": "Deletes a previously existing application.",
"operationId": "spectrum-applications-delete-spectrum-application",
"parameters": [
- { "in": "path", "name": "app_id", "required": true, "schema": { "$ref": "#/components/schemas/app_id" } },
+ {
+ "in": "path",
+ "name": "app_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/app_id" }
+ },
{
"in": "path",
"name": "zone",
@@ -75823,7 +83509,12 @@
"description": "Gets the application configuration of a specific application inside a zone.",
"operationId": "spectrum-applications-get-spectrum-application-configuration",
"parameters": [
- { "in": "path", "name": "app_id", "required": true, "schema": { "$ref": "#/components/schemas/app_id" } },
+ {
+ "in": "path",
+ "name": "app_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/app_id" }
+ },
{
"in": "path",
"name": "zone",
@@ -75833,7 +83524,11 @@
],
"responses": {
"200": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/schemas-response_single" }
+ }
+ },
"description": "Get Spectrum application configuration response"
},
"4xx": {
@@ -75858,7 +83553,12 @@
"description": "Updates a previously existing application's configuration that uses a name for the origin.",
"operationId": "spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin",
"parameters": [
- { "in": "path", "name": "app_id", "required": true, "schema": { "$ref": "#/components/schemas/app_id" } },
+ {
+ "in": "path",
+ "name": "app_id",
+ "required": true,
+ "schema": { "$ref": "#/components/schemas/app_id" }
+ },
{
"in": "path",
"name": "zone",
@@ -75892,7 +83592,9 @@
"responses": {
"200": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/response_single_origin_dns" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/response_single_origin_dns" }
+ }
},
"description": "Update Spectrum application configuration using a name for the origin response"
},
diff --git a/packages/loaders/openapi/tests/fixtures/government_social_work.json b/packages/loaders/openapi/tests/fixtures/government_social_work.json
index 966fac9f56c69..ef97007d8f021 100644
--- a/packages/loaders/openapi/tests/fixtures/government_social_work.json
+++ b/packages/loaders/openapi/tests/fixtures/government_social_work.json
@@ -3312,7 +3312,14 @@
"id": {
"type": "string",
"description": "server-generated error code",
- "enum": ["NO_RESULTS_FOUND", "SAVE_FAILED", "ADD_FAILED", "UPLOAD_FAILED", "SCAN_FAILED", "DELETE_FAILED"]
+ "enum": [
+ "NO_RESULTS_FOUND",
+ "SAVE_FAILED",
+ "ADD_FAILED",
+ "UPLOAD_FAILED",
+ "SCAN_FAILED",
+ "DELETE_FAILED"
+ ]
},
"message": {
"type": "string",
diff --git a/packages/loaders/openapi/tests/fixtures/jira.json b/packages/loaders/openapi/tests/fixtures/jira.json
index 7f2db8de4e44b..c746be0a84111 100644
--- a/packages/loaders/openapi/tests/fixtures/jira.json
+++ b/packages/loaders/openapi/tests/fixtures/jira.json
@@ -274,7 +274,10 @@
"name": "Screen schemes",
"description": "This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes."
},
- { "name": "Server info", "description": "This resource provides information about the Jira instance." },
+ {
+ "name": "Server info",
+ "description": "This resource provides information about the Jira instance."
+ },
{
"name": "Status",
"description": "This resource represents statuses. Use it to search, get, create, delete, and change statuses."
@@ -368,7 +371,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -421,7 +426,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -459,7 +466,11 @@
"schema": { "$ref": "#/components/schemas/MultipleCustomFieldValuesUpdateDetails" },
"example": {
"updates": [
- { "issueIds": [10010, 10011], "value": "new value", "customField": "customfield_10010" },
+ {
+ "issueIds": [10010, 10011],
+ "value": "new value",
+ "customField": "customfield_10010"
+ },
{ "issueIds": [10010], "value": 1000, "customField": "customfield_10011" }
]
}
@@ -506,13 +517,21 @@
"name": "id",
"in": "query",
"description": "The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "fieldContextId",
"in": "query",
"description": "The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or `issueTypeId`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "issueId",
@@ -556,7 +575,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field."
},
@@ -566,7 +587,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:custom-field-contextual-configuration:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:custom-field-contextual-configuration:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -594,7 +619,10 @@
{ "id": "10000" },
{
"schema": {
- "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } },
+ "properties": {
+ "amount": { "type": "number" },
+ "currency": { "type": "string" }
+ },
"required": ["amount", "currency"]
},
"configuration": { "minValue": 0, "maxValue": 10000 },
@@ -612,7 +640,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field."
},
@@ -622,7 +652,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:custom-field-contextual-configuration:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:custom-field-contextual-configuration:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -664,7 +698,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "403": { "description": "Returned if the request is not authenticated as the app that provided the field." },
+ "403": {
+ "description": "Returned if the request is not authenticated as the app that provided the field."
+ },
"404": { "description": "Returned if the field is not found." }
},
"deprecated": false,
@@ -708,12 +744,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationProperty" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ApplicationProperty" }
+ },
"example": "[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the application property is not found or the user does not have permission to view it."
}
@@ -739,12 +780,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationProperty" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ApplicationProperty" }
+ },
"example": "[{\"id\":\"jira.home\",\"key\":\"jira.home\",\"value\":\"/var/jira/jira-home\",\"name\":\"jira.home\",\"desc\":\"Jira home directory\",\"type\":\"string\",\"defaultValue\":\"\"},{\"id\":\"jira.clone.prefix\",\"key\":\"jira.clone.prefix\",\"value\":\"CLONE -\",\"name\":\"The prefix added to the Summary field of cloned issues\",\"type\":\"string\",\"defaultValue\":\"CLONE -\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user is not an administrator." }
},
"deprecated": false,
@@ -783,13 +829,21 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProperty" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/ApplicationProperty" }
+ }
+ }
},
"400": {
"description": "Returned if the data type of the `value` does not match the application property's data type. For example, a string is provided instead of an integer."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to edit the property." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to edit the property."
+ },
"404": {
"description": "Returned if the property is not found or the user does not have permission to view it."
}
@@ -819,12 +873,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationRole" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ApplicationRole" }
+ },
"example": "[{\"key\":\"jira-software\",\"groups\":[\"jira-software-users\",\"jira-testers\"],\"groupDetails\":[{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"},{\"name\":\"jira-testers\",\"groupId\":\"42c8955c-63d7-42c8-9520-63d7aca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=42c8955c-63d7-42c8-9520-63d7aca0625\"}],\"name\":\"Jira Software\",\"defaultGroups\":[\"jira-software-users\"],\"defaultGroupsDetails\":[{\"name\":\"jira-software-users\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":10,\"remainingSeats\":5,\"userCount\":5,\"userCountDescription\":\"5 developers\",\"hasUnlimitedSeats\":false,\"platform\":false},{\"key\":\"jira-core\",\"groups\":[\"jira-core-users\"],\"groupDetails\":[{\"name\":\"jira-core-users\",\"groupId\":\"92d01dca0625-42c8-42c8-9520-276f955c\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c\"}],\"name\":\"Jira Core\",\"defaultGroups\":[\"jira-core-users\"],\"defaultGroupsDetails\":[{\"name\":\"jira-core-users\",\"groupId\":\"92d01dca0625-42c8-42c8-9520-276f955c\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=92d01dca0625-42c8-42c8-9520-276f955c\"}],\"selectedByDefault\":false,\"defined\":false,\"numberOfSeats\":1,\"remainingSeats\":1,\"userCount\":0,\"userCountDescription\":\"0 users\",\"hasUnlimitedSeats\":false,\"platform\":true}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user is not an administrator." }
},
"deprecated": false,
@@ -858,7 +917,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user is not an administrator." },
"404": { "description": "Returned if the role is not found." }
},
@@ -899,13 +960,17 @@
"303": {
"description": "Returned if the request is successful. See the `Location` header for the download URL."
},
- "400": { "description": "Returned if the range supplied in the `Range` header is malformed." },
+ "400": {
+ "description": "Returned if the range supplied in the `Range` header is malformed."
+ },
"401": { "description": "Returned if the authentication credentials are incorrect." },
"403": { "description": "The user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings."
},
- "416": { "description": "Returned if the server is unable to satisfy the range of bytes provided." }
+ "416": {
+ "description": "Returned if the server is unable to satisfy the range of bytes provided."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -934,7 +999,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -1034,7 +1101,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings."
@@ -1113,12 +1182,16 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "The user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings."
},
- "409": { "description": "Returned if the attachment is an archive, but not a supported archive format." }
+ "409": {
+ "description": "Returned if the attachment is an archive, but not a supported archive format."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -1155,12 +1228,16 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "The user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the attachment is not found.\n * attachments are disabled in the Jira settings."
},
- "409": { "description": "Returned if the attachment is an archive, but not a supported archive format." }
+ "409": {
+ "description": "Returned if the attachment is an archive, but not a supported archive format."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -1220,7 +1297,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if:\n\n * the user does not have the required permissions.\n * all Jira products are on free plans. Audit logs are available when at least one Jira product is on a paid plan."
}
@@ -1229,7 +1308,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:audit-log:jira", "read:user:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:audit-log:jira", "read:user:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -1246,7 +1329,11 @@
"in": "path",
"description": "The avatar type.",
"required": true,
- "schema": { "type": "string", "example": "project", "enum": ["issuetype", "project", "user"] },
+ "schema": {
+ "type": "string",
+ "example": "project",
+ "enum": ["issuetype", "project", "user"]
+ },
"x-showInExample": "true"
}
],
@@ -1260,8 +1347,12 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "500": { "description": "Returned if an error occurs while retrieving the list of avatars." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "500": {
+ "description": "Returned if an error occurs while retrieving the list of avatars."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
@@ -1306,7 +1397,9 @@
}
}
},
- "400": { "description": "Returned if the request contains more than 1000 IDs or is empty." }
+ "400": {
+ "description": "Returned if the request contains more than 1000 IDs or is empty."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -1356,7 +1449,9 @@
}
},
"400": { "description": "Returned if the comment ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the comment is not found." }
},
@@ -1415,7 +1510,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the comment or the property is not found." }
},
@@ -1459,7 +1556,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the comment is not found." }
},
@@ -1495,7 +1594,9 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if the comment or the property is not found or the user has the necessary project permissions but isn't a member of the role or group visibility of the comment is restricted to."
@@ -1546,7 +1647,9 @@
"400": {
"description": "Returned if:\n\n * the user is not found.\n * `name` is not provided.\n * `name` is over 255 characters in length.\n * `projectId` is not provided.\n * `assigneeType` is an invalid value."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."
},
@@ -1600,7 +1703,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the component is not found or the user does not have permission to browse the project containing the component."
}
@@ -1666,7 +1771,9 @@
"400": {
"description": "Returned if:\n\n * the user is not found.\n * `assigneeType` is an invalid value.\n * `name` is over 255 characters in length."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."
},
@@ -1716,7 +1823,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have permission to manage the project containing the component or does not have permission to administer Jira."
},
@@ -1758,7 +1867,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the component is not found." }
},
"deprecated": false,
@@ -1787,7 +1898,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
@@ -1823,7 +1936,9 @@
"description": "Returned if the request is successful but time tracking is disabled.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -1855,7 +1970,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the time tracking provider is not found." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -1879,12 +1996,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeTrackingProvider" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/TimeTrackingProvider" }
+ },
"example": "[{\"key\":\"Jira\",\"name\":\"JIRA provided time tracking\",\"url\":\"/example/config/url\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -1913,7 +2035,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -1955,7 +2079,9 @@
}
},
"400": { "description": "Returned if the request object is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -1996,7 +2122,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the custom field option is not found.\n * the user does not have permission to view the custom field."
}
@@ -2005,7 +2133,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field:jira", "read:field.option:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field:jira", "read:field.option:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -2048,11 +2180,15 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2113,11 +2249,15 @@
},
"400": {
"description": "Returned if the request is not valid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2167,11 +2307,15 @@
},
"400": {
"description": "400 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2272,7 +2416,11 @@
"name": "status",
"in": "query",
"description": "The status to filter by. It may be active, archived or deleted.",
- "schema": { "type": "string", "default": "active", "enum": ["active", "archived", "deleted"] }
+ "schema": {
+ "type": "string",
+ "default": "active",
+ "enum": ["active", "archived", "deleted"]
+ }
},
{
"name": "expand",
@@ -2293,11 +2441,15 @@
},
"400": {
"description": "Returned if:\n\n * `orderBy` is invalid.\n * `expand` includes an invalid value.\n * `accountId` and `owner` are provided.\n * `groupname` and `groupId` are provided.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "401 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2437,7 +2589,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the dashboard is not found.",
"content": {
@@ -2451,8 +2605,16 @@
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work", "read:jira-work"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work", "read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:dashboard:jira", "read:dashboard:jira"] }
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["write:jira-work", "read:jira-work"]
+ },
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:dashboard:jira", "read:dashboard:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "WRITE"
@@ -2484,7 +2646,11 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/DashboardGadgetUpdateRequest" },
- "example": { "color": "red", "position": { "column": 1, "row": 1 }, "title": "My new gadget title" }
+ "example": {
+ "color": "red",
+ "position": { "column": 1, "row": 1 },
+ "title": "My new gadget title"
+ }
}
},
"required": true
@@ -2549,7 +2715,9 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the gadget or the dashboard is not found.",
"content": {
@@ -2602,7 +2770,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the dashboard or dashboard item is not found, or the dashboard is not owned by or shared with the user."
}
@@ -2668,7 +2838,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the dashboard, the dashboard item, or dashboard item property is not found, or the dashboard is not owned by or shared with the user."
}
@@ -2710,7 +2882,12 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": {}, "example": { "number": 5, "string": "string-value" } } },
+ "content": {
+ "application/json": {
+ "schema": {},
+ "example": { "number": 5, "string": "string-value" }
+ }
+ },
"required": true
},
"responses": {
@@ -2730,7 +2907,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user is not the owner of the dashboard." },
"404": {
"description": "Returned if the dashboard item is not found or the dashboard is not shared with the user."
@@ -2775,7 +2954,9 @@
"responses": {
"204": { "description": "Returned if the dashboard item property is deleted." },
"400": { "description": "Returned if the dashboard or dashboard item ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user is not the owner of the dashboard." },
"404": {
"description": "Returned if the dashboard item is not found or the dashboard is not shared with the user."
@@ -2817,11 +2998,15 @@
},
"400": {
"description": "400 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the dashboard is not found or the dashboard is not owned by or shared with the user."
@@ -2893,15 +3078,21 @@
},
"400": {
"description": "Returned if the request is not valid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the dashboard is not found or the dashboard is not owned by the user.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2949,11 +3140,15 @@
"204": { "description": "Returned if the dashboard is deleted." },
"400": {
"description": "400 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -2972,7 +3167,9 @@
"summary": "Copy dashboard",
"description": "Copies a dashboard. Any values provided in the `dashboard` parameter replace those in the copied dashboard.\n\n**[Permissions](#permissions) required:** None\n\nThe dashboard to be copied must be owned by or shared with the user.",
"operationId": "copyDashboard",
- "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }],
+ "parameters": [
+ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }
+ ],
"requestBody": {
"description": "Dashboard details.",
"content": {
@@ -3000,15 +3197,21 @@
},
"400": {
"description": "Returned if the request is not valid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the dashboard is not found or the dashboard is not owned by or shared with the user.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -3051,13 +3254,20 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueEvent" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueEvent" }
+ },
"example": "[{\"id\":1,\"name\":\"Issue Created\"},{\"id\":2,\"name\":\"Issue Updated\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to complete this request." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to complete this request."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -3080,7 +3290,11 @@
"name": "check",
"in": "query",
"description": "The check to perform:\n\n * `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length.\n * `type` EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check.\n * `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each expression may execute.",
- "schema": { "type": "string", "default": "syntax", "enum": ["syntax", "type", "complexity"] }
+ "schema": {
+ "type": "string",
+ "default": "syntax",
+ "enum": ["syntax", "type", "complexity"]
+ }
}
],
"requestBody": {
@@ -3112,19 +3326,33 @@
},
"400": {
"description": "400 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
"404": {
"description": "404 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "read:jira-user"] }, {}],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "read:jira-user"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field:jira", "read:jira-expressions:jira"] }
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "read:jira-user"]
+ },
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field:jira", "read:jira-expressions:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -3165,7 +3393,12 @@
"project": { "key": "ACJIRA" },
"serviceDesk": 10023,
"issues": {
- "jql": { "maxResults": 100, "query": "project = HSP", "startAt": 0, "validation": "strict" }
+ "jql": {
+ "maxResults": 100,
+ "query": "project = HSP",
+ "startAt": 0,
+ "validation": "strict"
+ }
},
"board": 10100,
"customerRequest": 1450
@@ -3194,7 +3427,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if any object provided in the request context is not found or the user does not have permission to view it.",
"content": {
@@ -3208,7 +3443,11 @@
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "read:jira-user"] }, {}],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "read:jira-user"] },
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "read:jira-user"]
+ },
{ "state": "Beta", "scheme": "OAuth2", "scopes": ["read:jira-expressions:jira"] }
],
"x-atlassian-connect-scope": "READ"
@@ -3226,12 +3465,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/FieldDetails" }
+ },
"example": "[{\"id\":\"description\",\"name\":\"Description\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"description\"],\"schema\":{\"type\":\"string\",\"system\":\"description\"}},{\"id\":\"summary\",\"key\":\"summary\",\"name\":\"Summary\",\"custom\":false,\"orderable\":true,\"navigable\":true,\"searchable\":true,\"clauseNames\":[\"summary\"],\"schema\":{\"type\":\"string\",\"system\":\"summary\"}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -3329,7 +3573,10 @@
"name": "type",
"in": "query",
"description": "The type of fields to search.",
- "schema": { "type": "array", "items": { "type": "string", "enum": ["custom", "system"] } }
+ "schema": {
+ "type": "array",
+ "items": { "type": "string", "enum": ["custom", "system"] }
+ }
},
{
"name": "id",
@@ -3391,7 +3638,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -3406,7 +3655,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field:jira", "read:field-configuration:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field:jira", "read:field-configuration:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "NONE"
@@ -3481,7 +3734,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -3548,7 +3803,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -3606,7 +3863,11 @@
"name": "contextId",
"in": "query",
"description": "The list of context IDs. To include multiple contexts, separate IDs with ampersand: `contextId=10000&contextId=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "startAt",
@@ -3631,7 +3892,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -3701,7 +3964,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the field, project, or issue type is not found." },
"409": {
"description": "Returned if the issue type is a sub-task, but sub-tasks are disabled in Jira settings.",
@@ -3719,7 +3984,11 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:field:jira", "write:field:jira", "read:custom-field-contextual-configuration:jira"]
+ "scopes": [
+ "read:field:jira",
+ "write:field:jira",
+ "read:custom-field-contextual-configuration:jira"
+ ]
}
],
"x-experimental": true,
@@ -3744,7 +4013,11 @@
"name": "contextId",
"in": "query",
"description": "The IDs of the contexts.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "startAt",
@@ -3769,7 +4042,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -3838,7 +4113,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -3850,7 +4127,9 @@
"404": {
"description": "Returned if the custom field, a context, an option, or a cascading option is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -3907,7 +4186,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -3988,7 +4269,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4034,7 +4317,11 @@
"name": "contextId",
"in": "query",
"description": "The list of context IDs. To include multiple context, separate IDs with ampersand: `contextId=10000&contextId=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "startAt",
@@ -4054,12 +4341,16 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/PageBeanCustomFieldContextProjectMapping" },
+ "schema": {
+ "$ref": "#/components/schemas/PageBeanCustomFieldContextProjectMapping"
+ },
"example": "{\"maxResults\":100,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"contextId\":\"10025\",\"projectId\":\"10001\"},{\"contextId\":\"10026\",\"isGlobalContext\":true}]}"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4134,7 +4425,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4146,7 +4439,9 @@
"404": {
"description": "Returned if the custom field or the context is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -4193,7 +4488,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4205,7 +4502,9 @@
"404": {
"description": "Returned if the custom field or the context is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -4263,7 +4562,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4275,7 +4576,9 @@
"404": {
"description": "Returned if the custom field, context, or one or more issue types are not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
},
"409": {
@@ -4341,7 +4644,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4353,7 +4658,9 @@
"404": {
"description": "Returned if the custom field, context, or one or more issue types are not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -4431,7 +4738,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -4512,7 +4821,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -4534,7 +4845,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field.option:jira", "write:field.option:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field.option:jira", "write:field.option:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -4593,7 +4908,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -4615,7 +4932,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field.option:jira", "write:field.option:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field.option:jira", "write:field.option:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -4665,7 +4986,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -4732,7 +5055,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -4804,7 +5129,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4816,7 +5143,9 @@
"404": {
"description": "Returned if the custom field, context, or project is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -4874,7 +5203,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -4886,7 +5217,9 @@
"404": {
"description": "Returned if the custom field, context, or one or more projects are not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The context was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -4937,7 +5270,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": true,
@@ -4947,7 +5282,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:field:jira", "read:avatar:jira", "read:project-category:jira", "read:project:jira"]
+ "scopes": [
+ "read:field:jira",
+ "read:avatar:jira",
+ "read:project-category:jira",
+ "read:project:jira"
+ ]
}
],
"x-atlassian-connect-scope": "NONE"
@@ -4996,7 +5336,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -5055,7 +5397,9 @@
}
}
},
- "400": { "description": "Returned if the field is not found or does not support options." },
+ "400": {
+ "description": "Returned if the field is not found or does not support options."
+ },
"403": {
"description": "Returned if the request is not authenticated as a Jira administrator or the app that provided the field."
}
@@ -5124,7 +5468,9 @@
"403": {
"description": "Returned if the request is not authenticated as a Jira administrator or the app that provided the field."
},
- "404": { "description": "Returned if the field is not found or does not support options." }
+ "404": {
+ "description": "Returned if the field is not found or does not support options."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -5178,8 +5524,12 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "404": { "description": "Returned if the field is not found or does not support options." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "404": {
+ "description": "Returned if the field is not found or does not support options."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -5233,8 +5583,12 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "404": { "description": "Returned if the field is not found or does not support options." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "404": {
+ "description": "Returned if the field is not found or does not support options."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -5277,7 +5631,9 @@
}
}
},
- "400": { "description": "Returned if the field is not found or does not support options." },
+ "400": {
+ "description": "Returned if the field is not found or does not support options."
+ },
"403": {
"description": "Returned if the request is not authenticated as a Jira administrator or the app that provided the field."
},
@@ -5459,7 +5815,9 @@
"description": "Returned if the long-running task to deselect the option is started.",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/TaskProgressBeanRemoveOptionFromIssuesResult" },
+ "schema": {
+ "$ref": "#/components/schemas/TaskProgressBeanRemoveOptionFromIssuesResult"
+ },
"example": "{\"self\":\"https://your-domain.atlassian.net/rest/api/3/task/1\",\"id\":\"1\",\"description\":\"Remove option 1 from issues matched by '*', and replace with option 3\",\"status\":\"COMPLETE\",\"result\":{\"modifiedIssues\":[10001,10010],\"unmodifiedIssues\":[10005],\"errors\":{\"errors\":{},\"errorMessages\":[\"Option 2 cannot be set on issue MKY-5 as it is not in the correct scope\"],\"httpStatusCode\":{\"present\":true}}},\"elapsedRuntime\":42}"
}
}
@@ -5481,7 +5839,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:field.option:jira", "delete:field.option:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:field.option:jira", "delete:field.option:jira"]
+ }
],
"x-atlassian-connect-scope": "NONE"
}
@@ -5504,27 +5866,41 @@
"responses": {
"303": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" }
+ }
+ }
},
"400": {
"description": "Returned if any of these are true:\n\n * The custom field is locked.\n * The custom field is used in a issue security scheme or a permission scheme.\n * The custom field ID format is incorrect.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the custom field is not found.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"409": {
"description": "Returned if a task to delete the custom field is running.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -5559,19 +5935,27 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the custom field is not found.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -5606,19 +5990,27 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the custom field is not found.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -5654,7 +6046,11 @@
"name": "id",
"in": "query",
"description": "The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "isDefault",
@@ -5679,7 +6075,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -5700,7 +6098,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/FieldConfigurationDetails" },
- "example": { "name": "My Field Configuration", "description": "My field configuration description" }
+ "example": {
+ "name": "My Field Configuration",
+ "description": "My field configuration description"
+ }
}
},
"required": true
@@ -5716,7 +6117,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -5752,7 +6155,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/FieldConfigurationDetails" },
- "example": { "name": "My Modified Field Configuration", "description": "A brand new description" }
+ "example": {
+ "name": "My Modified Field Configuration",
+ "description": "A brand new description"
+ }
}
},
"required": true
@@ -5763,7 +6169,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the field configuration is not found." }
},
@@ -5796,7 +6204,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the field configuration is not found." }
},
@@ -5847,7 +6257,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the field configuration is not found." }
},
@@ -5879,7 +6291,11 @@
"schema": { "$ref": "#/components/schemas/FieldConfigurationItemsDetails" },
"example": {
"fieldConfigurationItems": [
- { "description": "The new description of this item.", "id": "customfield_10012", "isHidden": false },
+ {
+ "description": "The new description of this item.",
+ "id": "customfield_10012",
+ "isHidden": false
+ },
{ "isRequired": true, "id": "customfield_10011" },
{
"isRequired": false,
@@ -5900,7 +6316,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the field configuration is not found." }
},
@@ -5937,7 +6355,11 @@
"name": "id",
"in": "query",
"description": "The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -5951,14 +6373,20 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permissions." }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field-configuration-scheme:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -5999,7 +6427,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permissions.",
"content": {
@@ -6016,7 +6446,10 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["write:field-configuration-scheme:jira", "read:field-configuration-scheme:jira"]
+ "scopes": [
+ "write:field-configuration-scheme:jira",
+ "read:field-configuration-scheme:jira"
+ ]
}
],
"x-experimental": true,
@@ -6060,13 +6493,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/PageBeanFieldConfigurationIssueTypeItem" },
+ "schema": {
+ "$ref": "#/components/schemas/PageBeanFieldConfigurationIssueTypeItem"
+ },
"example": "{\"maxResults\":100,\"startAt\":0,\"total\":5,\"isLast\":true,\"values\":[{\"fieldConfigurationSchemeId\":\"10020\",\"issueTypeId\":\"10000\",\"fieldConfigurationId\":\"10010\"},{\"fieldConfigurationSchemeId\":\"10020\",\"issueTypeId\":\"10001\",\"fieldConfigurationId\":\"10010\"},{\"fieldConfigurationSchemeId\":\"10021\",\"issueTypeId\":\"10002\",\"fieldConfigurationId\":\"10000\"},{\"fieldConfigurationSchemeId\":\"10022\",\"issueTypeId\":\"default\",\"fieldConfigurationId\":\"10011\"},{\"fieldConfigurationSchemeId\":\"10023\",\"issueTypeId\":\"default\",\"fieldConfigurationId\":\"10000\"}]}"
}
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if no field configuration schemes are found." }
},
@@ -6074,7 +6511,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field-configuration-scheme:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -6103,7 +6544,11 @@
"in": "query",
"description": "The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.",
"required": true,
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -6111,20 +6556,28 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/PageBeanFieldConfigurationSchemeProjects" },
+ "schema": {
+ "$ref": "#/components/schemas/PageBeanFieldConfigurationSchemeProjects"
+ },
"example": "{\"maxResults\":50,\"startAt\":0,\"total\":5,\"isLast\":true,\"values\":[{\"projectIds\":[\"10\",\"11\"]},{\"fieldConfigurationScheme\":{\"id\":\"10002\",\"name\":\"Field Configuration Scheme for software related projects\",\"description\":\"We can use this one for software projects.\"},\"projectIds\":[\"12\",\"13\",\"14\"]}]}"
}
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field-configuration-scheme:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -6137,7 +6590,9 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/FieldConfigurationSchemeProjectAssociation" },
+ "schema": {
+ "$ref": "#/components/schemas/FieldConfigurationSchemeProjectAssociation"
+ },
"example": { "fieldConfigurationSchemeId": "10000", "projectId": "10000" }
}
},
@@ -6156,7 +6611,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permissions.",
"content": {
@@ -6168,7 +6625,9 @@
"404": {
"description": "Returned if the project is missing.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The project was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The project was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -6176,7 +6635,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:field-configuration-scheme:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -6222,7 +6685,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permissions.",
"content": {
@@ -6244,7 +6709,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:field-configuration-scheme:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -6269,7 +6738,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the field configuration scheme is not found." }
},
@@ -6277,7 +6748,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:field-configuration-scheme:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -6301,7 +6776,9 @@
"requestBody": {
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/AssociateFieldConfigurationsWithIssueTypesRequest" },
+ "schema": {
+ "$ref": "#/components/schemas/AssociateFieldConfigurationsWithIssueTypesRequest"
+ },
"example": {
"mappings": [
{ "issueTypeId": "default", "fieldConfigurationId": "10000" },
@@ -6319,7 +6796,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if the field configuration scheme, the field configuration, or the issue type is not found."
@@ -6332,7 +6811,10 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["write:field-configuration-scheme:jira", "read:field-configuration-scheme:jira"]
+ "scopes": [
+ "write:field-configuration-scheme:jira",
+ "read:field-configuration-scheme:jira"
+ ]
}
],
"x-experimental": true,
@@ -6380,7 +6862,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -6405,7 +6889,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:field-configuration-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:field-configuration-scheme:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -6429,7 +6917,9 @@
"200": {
"description": "200 response",
"content": {
- "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Filter" } } }
+ "application/json": {
+ "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Filter" } }
+ }
}
}
},
@@ -6509,7 +6999,9 @@
"400": {
"description": "Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -6555,13 +7047,19 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:filter.default-share-scope:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:filter.default-share-scope:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
},
@@ -6591,7 +7089,9 @@
}
},
"400": { "description": "Returned if an invalid scope is set." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -6600,7 +7100,10 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["write:filter.default-share-scope:jira", "read:filter.default-share-scope:jira"]
+ "scopes": [
+ "write:filter.default-share-scope:jira",
+ "read:filter.default-share-scope:jira"
+ ]
}
],
"x-atlassian-connect-scope": "WRITE"
@@ -6630,7 +7133,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -6685,7 +7190,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -6757,7 +7264,11 @@
"name": "id",
"in": "query",
"description": "The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "orderBy",
@@ -6828,9 +7339,13 @@
},
"400": {
"description": "Returned if:\n\n * `owner` and `accountId` are provided.\n * `expand` includes an invalid value.\n * `orderBy` is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -6895,7 +7410,9 @@
"400": {
"description": "Returned if the filter is not found or the user does not have permission to view it."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -6972,7 +7489,9 @@
"400": {
"description": "Returned if the request object is invalid. For example, the `name` is not unique or the project ID is not specified for a project role share permission."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -7014,7 +7533,9 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the filter is not found." },
- "401": { "description": "Returned if the user does not have permission to delete the filter." }
+ "401": {
+ "description": "Returned if the user does not have permission to delete the filter."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -7045,13 +7566,20 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnItem" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ColumnItem" }
+ },
"example": "[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]"
}
}
},
- "400": { "description": "Returned if the user does not have permission to view the filter." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the user does not have permission to view the filter."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if a column configuration is not set for the filter." }
},
"deprecated": false,
@@ -7120,7 +7648,9 @@
"400": {
"description": "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -7286,12 +7816,18 @@
"403": {
"description": "Returned if the requesting user is not an owner of the filter or does not have *Administer Jira* global permission."
},
- "404": { "description": "Returned if the filter or the new owner of the filter is not found." }
+ "404": {
+ "description": "Returned if the filter or the new owner of the filter is not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:filter:jira", "write:filter:jira"] },
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:filter:jira", "write:filter:jira"]
+ },
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] }
],
"x-experimental": true,
@@ -7318,12 +7854,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SharePermission" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/SharePermission" }
+ },
"example": "[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2022-08-03T23:55:25.789+0000\"}}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2022-08-03T23:55:25.789+0000\"},\"deleted\":true,\"retentionTillDate\":\"2022-10-02T23:55:25.790+0000\",\"deletedDate\":\"2022-08-03T23:55:25.790+0000\",\"deletedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}},\"role\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter."
}
@@ -7381,7 +7922,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SharePermission" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/SharePermission" }
+ },
"example": "[{\"id\":10000,\"type\":\"global\"},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"id\":\"10000\",\"key\":\"EX\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2022-08-03T23:55:25.789+0000\"}}},{\"id\":10010,\"type\":\"project\",\"project\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY\",\"id\":\"10002\",\"key\":\"MKY\",\"name\":\"Example\",\"avatarUrls\":{\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002\",\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002\"},\"projectCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},\"simplified\":false,\"style\":\"classic\",\"insight\":{\"totalIssueCount\":100,\"lastIssueUpdateTime\":\"2022-08-03T23:55:25.789+0000\"},\"deleted\":true,\"retentionTillDate\":\"2022-10-02T23:55:25.790+0000\",\"deletedDate\":\"2022-08-03T23:55:25.790+0000\",\"deletedBy\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false}},\"role\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}},{\"id\":10010,\"type\":\"group\",\"group\":{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}}]"
}
}
@@ -7389,7 +7933,9 @@
"400": {
"description": "Returned if:\n\n * the request object is invalid. For example, it contains an invalid type, the ID does not match the type, or the project or group is not found.\n * the user does not own the filter.\n * the user does not have the required permissions."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the filter is not found.\n * the user does not have permission to view the filter."
}
@@ -7453,7 +7999,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the filter is not found.\n * the permission is not found.\n * the user does not have permission to view the filter."
}
@@ -7506,7 +8054,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the filter is not found.\n * the user does not own the filter."
}
@@ -7550,18 +8100,28 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/Group" } }
+ }
},
"400": { "description": "Returned if the group name is not specified." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the calling user does not have the Administer Jira global permission." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the calling user does not have the Administer Jira global permission."
+ },
"404": { "description": "Returned if the group is not found." }
},
"deprecated": true,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-user"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:group:jira", "read:user:jira", "read:avatar:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:group:jira", "read:user:jira", "read:avatar:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -7591,8 +8151,12 @@
}
}
},
- "400": { "description": "Returned if group name is not specified or the group name is in use." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if group name is not specified or the group name is in use."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -7706,7 +8270,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -7776,15 +8342,23 @@
}
},
"400": { "description": "Returned if the group name is not specified." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the calling user does not have the Administer Jira global permission." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the calling user does not have the Administer Jira global permission."
+ },
"404": { "description": "Returned if the group is not found." }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:group:jira", "read:user:jira", "read:avatar:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:group:jira", "read:user:jira", "read:avatar:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -7823,13 +8397,19 @@
"responses": {
"201": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/Group" } }
+ }
+ },
+ "400": {
+ "description": "Returned if:\n\n * `groupname` is not provided.\n * `accountId` is missing."
},
- "400": { "description": "Returned if:\n\n * `groupname` is not provided.\n * `accountId` is missing." },
"401": {
"description": "Returned if the authentication credentials are incorrect or missing from the request."
},
- "403": { "description": "Returned if the calling user does not have the necessary permission." },
+ "403": {
+ "description": "Returned if the calling user does not have the necessary permission."
+ },
"404": { "description": "Returned if the group or user are not found." }
},
"deprecated": false,
@@ -7880,7 +8460,9 @@
],
"responses": {
"200": { "description": "Returned if the request is successful." },
- "400": { "description": "Returned if:\n\n * `groupName` is missing.\n * `accountId` is missing." },
+ "400": {
+ "description": "Returned if:\n\n * `groupName` is missing.\n * `accountId` is missing."
+ },
"401": {
"description": "Returned if the authentication credentials are incorrect or missing from the request."
},
@@ -8060,7 +8642,9 @@
}
},
"400": { "description": "Returned if the query parameter is not provided." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
@@ -8092,7 +8676,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -8134,7 +8720,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Occurs on all orders", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Occurs on all orders", "type": "text" }]
+ }
]
},
"customfield_70000": ["jira-administrators", "jira-software-users"],
@@ -8145,7 +8734,9 @@
"content": [
{
"type": "paragraph",
- "content": [{ "text": "Order entry fails when selecting supplier.", "type": "text" }]
+ "content": [
+ { "text": "Order entry fails when selecting supplier.", "type": "text" }
+ ]
}
]
},
@@ -8161,7 +8752,9 @@
"environment": {
"type": "doc",
"version": 1,
- "content": [{ "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }]
+ "content": [
+ { "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }
+ ]
},
"versions": [{ "id": "10000" }],
"duedate": "2019-05-11",
@@ -8170,7 +8763,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Could impact day-to-day work.", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Could impact day-to-day work.", "type": "text" }]
+ }
]
},
"assignee": { "id": "5b109f2e9729b51b54dc274d" }
@@ -8201,11 +8797,15 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -8242,7 +8842,9 @@
"issueUpdates": [
{
"update": {
- "worklog": [{ "add": { "timeSpent": "60m", "started": "2019-07-05T11:05:00.000+0000" } }]
+ "worklog": [
+ { "add": { "timeSpent": "60m", "started": "2019-07-05T11:05:00.000+0000" } }
+ ]
},
"fields": {
"summary": "Main order flow broken",
@@ -8253,7 +8855,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Occurs on all orders", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Occurs on all orders", "type": "text" }]
+ }
]
},
"customfield_70000": ["jira-administrators", "jira-software-users"],
@@ -8264,7 +8869,12 @@
"content": [
{
"type": "paragraph",
- "content": [{ "text": "Order entry fails when selecting supplier.", "type": "text" }]
+ "content": [
+ {
+ "text": "Order entry fails when selecting supplier.",
+ "type": "text"
+ }
+ ]
}
]
},
@@ -8280,7 +8890,9 @@
"environment": {
"type": "doc",
"version": 1,
- "content": [{ "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }]
+ "content": [
+ { "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }
+ ]
},
"versions": [{ "id": "10000" }],
"duedate": "2011-03-11",
@@ -8309,7 +8921,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Occurs on all orders", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Occurs on all orders", "type": "text" }]
+ }
]
},
"customfield_70000": ["jira-administrators", "jira-software-users"],
@@ -8320,7 +8935,9 @@
"content": [
{
"type": "paragraph",
- "content": [{ "text": "Order remains pending after approved.", "type": "text" }]
+ "content": [
+ { "text": "Order remains pending after approved.", "type": "text" }
+ ]
}
]
},
@@ -8336,7 +8953,9 @@
"environment": {
"type": "doc",
"version": 1,
- "content": [{ "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }]
+ "content": [
+ { "type": "paragraph", "content": [{ "text": "UAT", "type": "text" }] }
+ ]
},
"versions": [{ "id": "10000" }],
"duedate": "2019-04-16",
@@ -8379,7 +8998,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -8448,7 +9069,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -8511,9 +9134,15 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuePickerSuggestions" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/IssuePickerSuggestions" }
+ }
+ }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -8533,18 +9162,26 @@
"parameters": [],
"requestBody": {
"description": "Issue properties to be set or updated with values.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueEntityProperties" } } },
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/IssueEntityProperties" }
+ }
+ },
"required": true
},
"responses": {
"303": { "description": "Returned if the operation is successful." },
"400": {
"description": "Return if the request is invalid or the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -8571,8 +9208,14 @@
"schema": { "$ref": "#/components/schemas/MultiIssueEntityProperties" },
"example": {
"issues": [
- { "issueID": 1000, "properties": { "myProperty": { "owner": "admin", "weight": 100 } } },
- { "issueID": 1001, "properties": { "myOtherProperty": { "cost": 150, "transportation": "car" } } }
+ {
+ "issueID": 1000,
+ "properties": { "myProperty": { "owner": "admin", "weight": 100 } }
+ },
+ {
+ "issueID": 1001,
+ "properties": { "myOtherProperty": { "cost": 150, "transportation": "car" } }
+ }
]
}
}
@@ -8583,15 +9226,21 @@
"303": { "description": "Returned if the operation is successful." },
"400": {
"description": "Return if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Return if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -8639,18 +9288,26 @@
"303": { "description": "Returned if the request is successful." },
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:jira-expressions:jira", "write:issue.property:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-expressions:jira", "write:issue.property:jira"]
+ }
],
"x-atlassian-connect-scope": "WRITE"
},
@@ -8681,11 +9338,15 @@
"303": { "description": "Returned if the request is successful." },
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -8724,13 +9385,19 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue.watcher:jira", "read:user:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue.watcher:jira", "read:user:jira"]
+ }
],
"x-atlassian-connect-scope": "WRITE"
}
@@ -8790,7 +9457,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view it."
}
@@ -8872,7 +9541,9 @@
"update": {
"summary": [{ "set": "Bug in business logic" }],
"components": [{ "set": "" }],
- "timetracking": [{ "edit": { "remainingEstimate": "4d", "originalEstimate": "1w 1d" } }],
+ "timetracking": [
+ { "edit": { "remainingEstimate": "4d", "originalEstimate": "1w 1d" } }
+ ],
"labels": [{ "add": "triaged" }, { "remove": "blocker" }]
},
"fields": {
@@ -8882,7 +9553,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Investigation underway", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Investigation underway", "type": "text" }]
+ }
]
}
},
@@ -8903,7 +9577,9 @@
"400": {
"description": "Returned if:\n\n * the request body is missing.\n * the user does not have the necessary permission to edit one or more fields.\n * the request includes one or more fields that are not found or are not associated with the issue's edit screen.\n * the request includes an invalid transition."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user uses `overrideScreenSecurity` or `overrideEditableFlag` but doesn't have the necessary permission."
},
@@ -8941,9 +9617,13 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "400": { "description": "Returned if the issue has subtasks and `deleteSubtasks` is not set to *true*." },
+ "400": {
+ "description": "Returned if the issue has subtasks and `deleteSubtasks` is not set to *true*."
+ },
"401": { "description": "Returned if the authentication credentials are incorrect." },
- "403": { "description": "Returned if the user does not have permission to delete the issue." },
+ "403": {
+ "description": "Returned if the user does not have permission to delete the issue."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view the issue."
}
@@ -9017,13 +9697,20 @@
"schema": { "type": "string" }
}
],
- "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "string", "format": "binary" } } } },
+ "requestBody": {
+ "content": {
+ "multipart/form-data": { "schema": { "type": "string", "format": "binary" } }
+ }
+ },
"responses": {
"200": {
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/Attachment" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10000\",\"id\":\"10001\",\"filename\":\"picture.jpg\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2022-08-03T23:55:35.868+0000\",\"size\":23123,\"mimeType\":\"image/jpeg\",\"content\":\"https://your-domain.atlassian.net/rest/api/3/attachment/content/10000\",\"thumbnail\":\"https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10000\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/attachments/10001\",\"filename\":\"dbeuglog.txt\",\"author\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"accountId\":\"5b10a2844c20165700ede21g\",\"emailAddress\":\"mia@example.com\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":true,\"timeZone\":\"Australia/Sydney\"},\"created\":\"2022-08-03T23:55:35.868+0000\",\"size\":2460,\"mimeType\":\"text/plain\",\"content\":\"https://your-domain.atlassian.net/rest/api/3/attachment/content/10001\"}]"
}
}
@@ -9043,7 +9730,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:user:jira", "write:attachment:jira", "read:attachment:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:user:jira",
+ "write:attachment:jira",
+ "read:attachment:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "WRITE"
@@ -9205,7 +9897,9 @@
}
},
"400": { "description": "Returned if `orderBy` is set to a value other than *created*." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view it."
}
@@ -9255,7 +9949,11 @@
"application/json": {
"schema": { "$ref": "#/components/schemas/Comment" },
"example": {
- "visibility": { "identifier": "Administrators", "type": "role", "value": "Administrators" },
+ "visibility": {
+ "identifier": "Administrators",
+ "type": "role",
+ "value": "Administrators"
+ },
"body": {
"type": "doc",
"version": 1,
@@ -9352,7 +10050,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."
}
@@ -9421,7 +10121,11 @@
"application/json": {
"schema": { "$ref": "#/components/schemas/Comment" },
"example": {
- "visibility": { "identifier": "Administrators", "type": "role", "value": "Administrators" },
+ "visibility": {
+ "identifier": "Administrators",
+ "type": "role",
+ "value": "Administrators"
+ },
"body": {
"type": "doc",
"version": 1,
@@ -9455,7 +10159,9 @@
"400": {
"description": "Returned if the user does not have permission to edit the comment or the request is invalid."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."
}
@@ -9504,8 +10210,12 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "400": { "description": "Returned if the user does not have permission to delete the comment." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the user does not have permission to delete the comment."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue or comment is not found or the user does not have permission to view the issue or comment."
},
@@ -9515,7 +10225,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:comment:jira", "delete:comment.property:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:comment:jira", "delete:comment.property:jira"]
+ }
],
"x-atlassian-connect-scope": "DELETE"
}
@@ -9557,7 +10271,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user uses an override parameter but doesn't have permission to do so."
},
@@ -9569,7 +10285,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue-meta:jira", "read:field-configuration:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue-meta:jira", "read:field-configuration:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -9722,7 +10442,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue or property is not found or the user does not have permission to see the issue."
}
@@ -9767,8 +10489,12 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to edit the issue." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to edit the issue."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view the issue."
}
@@ -9804,7 +10530,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue or property is not found, or the user does not have permission to edit the issue."
}
@@ -9851,7 +10579,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if issue linking is disabled." },
"404": {
"description": "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."
@@ -9861,7 +10591,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue.remote-link:jira", "read:status:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue.remote-link:jira", "read:status:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
},
@@ -9889,7 +10623,10 @@
"relationship": "causes",
"object": {
"summary": "Customer support issue",
- "icon": { "url16x16": "http://www.mycompany.com/support/ticket.png", "title": "Support Ticket" },
+ "icon": {
+ "url16x16": "http://www.mycompany.com/support/ticket.png",
+ "title": "Support Ticket"
+ },
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1",
"status": {
@@ -9933,7 +10670,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have permission to link issues." },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view the issue."
@@ -9946,7 +10685,11 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["write:issue:jira", "write:issue.remote-link:jira", "read:issue.remote-link:jira"]
+ "scopes": [
+ "write:issue:jira",
+ "write:issue.remote-link:jira",
+ "read:issue.remote-link:jira"
+ ]
}
],
"x-atlassian-connect-scope": "WRITE"
@@ -9970,14 +10713,19 @@
"in": "query",
"description": "The global ID of a remote issue link.",
"required": true,
- "schema": { "type": "string", "example": "system=http://www.mycompany.com/support&id=1" },
+ "schema": {
+ "type": "string",
+ "example": "system=http://www.mycompany.com/support&id=1"
+ },
"x-showInExample": "true"
}
],
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if a global ID isn't provided." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have permission to link issues." },
"404": {
"description": "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."
@@ -9987,7 +10735,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:issue.remote-link:jira", "write:issue:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:issue.remote-link:jira", "write:issue:jira"]
+ }
],
"x-atlassian-connect-scope": "DELETE"
}
@@ -10027,7 +10779,9 @@
"400": {
"description": "Returned if the link ID is invalid or the remote issue link does not belong to the issue."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if issue linking is disabled." },
"404": {
"description": "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."
@@ -10037,7 +10791,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue.remote-link:jira", "read:status:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue.remote-link:jira", "read:status:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
},
@@ -10074,7 +10832,10 @@
"relationship": "causes",
"object": {
"summary": "Customer support issue",
- "icon": { "url16x16": "http://www.mycompany.com/support/ticket.png", "title": "Support Ticket" },
+ "icon": {
+ "url16x16": "http://www.mycompany.com/support/ticket.png",
+ "title": "Support Ticket"
+ },
"title": "TSTSUP-111",
"url": "http://www.mycompany.com/support?id=1",
"status": {
@@ -10104,7 +10865,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have permission to link issues." },
"404": {
"description": "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."
@@ -10114,7 +10877,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:issue:jira", "write:issue.remote-link:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:issue:jira", "write:issue.remote-link:jira"]
+ }
],
"x-atlassian-connect-scope": "WRITE"
},
@@ -10146,7 +10913,9 @@
"400": {
"description": "Returned if the link ID is invalid or the remote issue link does not belong to the issue."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have permission to link issues." },
"404": {
"description": "Returned if the issue or remote issue link is not found or the user does not have permission to view the issue."
@@ -10156,7 +10925,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:issue.remote-link:jira", "write:issue:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:issue.remote-link:jira", "write:issue:jira"]
+ }
],
"x-atlassian-connect-scope": "DELETE"
}
@@ -10216,7 +10989,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view it."
}
@@ -10228,7 +11003,11 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:issue.transition:jira", "read:status:jira", "read:field-configuration:jira"]
+ "scopes": [
+ "read:issue.transition:jira",
+ "read:status:jira",
+ "read:field-configuration:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -10275,7 +11054,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Bug has been fixed", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Bug has been fixed", "type": "text" }]
+ }
]
}
}
@@ -10297,7 +11079,9 @@
"400": {
"description": "Returned if:\n\n * no transition is specified.\n * the user does not have permission to transition the issue.\n * a field that isn't included on the transition screen is defined in `fields` or `update`.\n * a field is specified in both `fields` and `update`.\n * the request is invalid for any other reason."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view it."
}
@@ -10306,7 +11090,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["write:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:issue:jira", "write:issue.property:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:issue:jira", "write:issue.property:jira"]
+ }
],
"x-atlassian-connect-scope": "WRITE"
}
@@ -10336,7 +11124,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * voting is disabled.\n * the user does not have permission to view the issue.\n * the issue is not found."
}
@@ -10379,8 +11169,12 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "404": { "description": "Returned if:\n\n * voting is disabled.\n * the issue is not found." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "404": {
+ "description": "Returned if:\n\n * voting is disabled.\n * the issue is not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["write:jira-work"] }, {}],
@@ -10406,7 +11200,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * voting is disabled.\n * the user has not voted on the issue.\n * the issue is not found."
}
@@ -10445,7 +11241,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue is not found or the user does not have permission to view it."
}
@@ -10487,8 +11285,12 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have the permission to manage the watcher list." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have the permission to manage the watcher list."
+ },
"404": {
"description": "Returned if the issue or the user is not found or the user does not have permission to view the issue."
}
@@ -10531,8 +11333,12 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if `accountId` is not supplied." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have the permission to manage the watcher list." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have the permission to manage the watcher list."
+ },
"404": {
"description": "Returned if the issue or the user is not found or the user does not have permission to view the issue."
}
@@ -10601,7 +11407,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the issue is not found or the user does not have permission to view the issue.\n * `startAt` or `maxResults` has non-numeric values.\n * time tracking is disabled."
}
@@ -10648,7 +11456,11 @@
"name": "adjustEstimate",
"in": "query",
"description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Reduces the estimate by amount specified in `reduceBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog.",
- "schema": { "type": "string", "default": "auto", "enum": ["new", "leave", "manual", "auto"] }
+ "schema": {
+ "type": "string",
+ "default": "auto",
+ "enum": ["new", "leave", "manual", "auto"]
+ }
},
{
"name": "newEstimate",
@@ -10681,11 +11493,19 @@
"schema": { "$ref": "#/components/schemas/Worklog" },
"example": {
"timeSpentSeconds": 12000,
- "visibility": { "identifier": "276f955c-63d7-42c8-9520-92d01dca0625", "type": "group" },
+ "visibility": {
+ "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+ "type": "group"
+ },
"comment": {
"type": "doc",
"version": 1,
- "content": [{ "type": "paragraph", "content": [{ "text": "I did some work here.", "type": "text" }] }]
+ "content": [
+ {
+ "type": "paragraph",
+ "content": [{ "text": "I did some work here.", "type": "text" }]
+ }
+ ]
},
"started": "2021-01-17T12:34:00.000+0000"
}
@@ -10696,7 +11516,9 @@
"responses": {
"201": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Worklog" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/Worklog" } }
+ }
},
"400": {
"description": "Returned if:\n\n * `adjustEstimate` is set to `new` but `newEstimate` is not provided or is invalid.\n * `adjustEstimate` is set to `manual` but `reduceBy` is not provided or is invalid.\n * the user does not have permission to add the worklog.\n * the request JSON is malformed."
@@ -10821,7 +11643,11 @@
"name": "adjustEstimate",
"in": "query",
"description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or `timeSpentSeconds`.",
- "schema": { "type": "string", "default": "auto", "enum": ["new", "leave", "manual", "auto"] }
+ "schema": {
+ "type": "string",
+ "default": "auto",
+ "enum": ["new", "leave", "manual", "auto"]
+ }
},
{
"name": "newEstimate",
@@ -10848,11 +11674,19 @@
"schema": { "$ref": "#/components/schemas/Worklog" },
"example": {
"timeSpentSeconds": 12000,
- "visibility": { "identifier": "276f955c-63d7-42c8-9520-92d01dca0625", "type": "group" },
+ "visibility": {
+ "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
+ "type": "group"
+ },
"comment": {
"type": "doc",
"version": 1,
- "content": [{ "type": "paragraph", "content": [{ "text": "I did some work here.", "type": "text" }] }]
+ "content": [
+ {
+ "type": "paragraph",
+ "content": [{ "text": "I did some work here.", "type": "text" }]
+ }
+ ]
},
"started": "2021-01-17T12:34:00.000+0000"
}
@@ -10931,7 +11765,11 @@
"name": "adjustEstimate",
"in": "query",
"description": "Defines how to update the issue's time estimate, the options are:\n\n * `new` Sets the estimate to a specific value, defined in `newEstimate`.\n * `leave` Leaves the estimate unchanged.\n * `manual` Increases the estimate by amount specified in `increaseBy`.\n * `auto` Reduces the estimate by the value of `timeSpent` in the worklog.",
- "schema": { "type": "string", "default": "auto", "enum": ["new", "leave", "manual", "auto"] }
+ "schema": {
+ "type": "string",
+ "default": "auto",
+ "enum": ["new", "leave", "manual", "auto"]
+ }
},
{
"name": "newEstimate",
@@ -11012,7 +11850,9 @@
}
},
"400": { "description": "Returned if the worklog ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the issue or worklog is not found.\n * the user does not have permission to view the issue or worklog."
}
@@ -11079,7 +11919,9 @@
}
},
"400": { "description": "Returned if the worklog ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the issue, worklog, or property is not found.\n * the user does not have permission to view the issue or worklog."
}
@@ -11131,8 +11973,12 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the worklog ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to edit the worklog." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to edit the worklog."
+ },
"404": {
"description": "Returned if:\n\n * the issue or worklog is not found.\n * the user does not have permission to view the issue or worklog."
}
@@ -11176,8 +12022,12 @@
"responses": {
"204": { "description": "Returned if the worklog property is removed." },
"400": { "description": "Returned if the worklog key or id is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to edit the worklog." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to edit the worklog."
+ },
"404": {
"description": "Returned if:\n\n * the issue, worklog, or property is not found.\n * the user does not have permission to view the issue or worklog."
}
@@ -11215,7 +12065,10 @@
"type": "doc",
"version": 1,
"content": [
- { "type": "paragraph", "content": [{ "text": "Linked related issue!", "type": "text" }] }
+ {
+ "type": "paragraph",
+ "content": [{ "text": "Linked related issue!", "type": "text" }]
+ }
]
}
},
@@ -11234,7 +12087,9 @@
"400": {
"description": "Returned if the comment is not created. The response contains an error message indicating why the comment wasn't created. The issue link is also not created."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the user cannot view one or both of the issues. For example, the user doesn't have *Browse project* project permission for a project containing one of the issues.\n * the user does not have *link issues* project permission.\n * either of the link issues are not found.\n * the issue link type is not found."
}
@@ -11278,7 +12133,9 @@
}
},
"400": { "description": "Returned if the issue link ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link is not found.\n * the user doesn't have the required permissions."
}
@@ -11325,7 +12182,9 @@
"200": { "description": "200 response" },
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the issue link ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link is not found.\n * the user doesn't have the required permissions."
}
@@ -11356,7 +12215,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if issue linking is disabled." }
},
"deprecated": false,
@@ -11393,7 +12254,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link type name is in use.\n * the user does not have the required permissions."
}
@@ -11433,7 +12296,9 @@
}
},
"400": { "description": "Returned if the issue link type ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions."
}
@@ -11479,8 +12344,12 @@
}
}
},
- "400": { "description": "Returned if the issue link type ID or the request body are invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the issue link type ID or the request body are invalid."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions."
}
@@ -11489,7 +12358,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue-link-type:jira", "write:issue-link-type:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue-link-type:jira", "write:issue-link-type:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -11510,7 +12383,9 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the issue link type ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * issue linking is disabled.\n * the issue link type is not found.\n * the user does not have the required permissions."
}
@@ -11584,7 +12459,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the administrator permission and the scheme is not used in any project where the user has administrative permission."
}
@@ -11632,7 +12509,11 @@
"name": "issueSecurityLevelId",
"in": "query",
"description": "The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: `issueSecurityLevelId=10000&issueSecurityLevelId=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "expand",
@@ -11652,7 +12533,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if no issue security level members are found." }
},
@@ -11663,7 +12546,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:field:jira", "read:issue-security-level:jira", "read:project-role:jira", "read:user:jira"]
+ "scopes": [
+ "read:field:jira",
+ "read:issue-security-level:jira",
+ "read:project-role:jira",
+ "read:user:jira"
+ ]
}
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
@@ -11681,12 +12569,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTypeDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueTypeDetails" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -11695,7 +12588,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:issue-type:jira", "read:avatar:jira", "read:project-category:jira", "read:project:jira"]
+ "scopes": [
+ "read:issue-type:jira",
+ "read:avatar:jira",
+ "read:project-category:jira",
+ "read:project:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -11718,12 +12616,16 @@
"responses": {
"201": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDetails" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDetails" } }
+ }
},
"400": {
"description": "Returned if the request is invalid because:\n\n * no content is sent.\n * the issue type name exceeds 60 characters.\n * a subtask issue type is requested on an instance where subtasks are disabled."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"409": { "description": "Returned if the issue type name is in use." }
},
@@ -11772,13 +12674,18 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTypeDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueTypeDetails" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"
}
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the project is not found.\n * the user does not have the necessary permission."
}
@@ -11790,7 +12697,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:issue-type:jira", "read:avatar:jira", "read:project-category:jira", "read:project:jira"]
+ "scopes": [
+ "read:issue-type:jira",
+ "read:avatar:jira",
+ "read:project-category:jira",
+ "read:project:jira"
+ ]
}
],
"x-experimental": true,
@@ -11823,7 +12735,9 @@
}
},
"400": { "description": "Returned if the issue type ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the issue type is not found.\n * the user does not have the required permissions."
}
@@ -11835,7 +12749,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:issue-type:jira", "read:avatar:jira", "read:project-category:jira", "read:project:jira"]
+ "scopes": [
+ "read:issue-type:jira",
+ "read:avatar:jira",
+ "read:project-category:jira",
+ "read:project:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -11866,12 +12785,16 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDetails" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/IssueTypeDetails" } }
+ }
},
"400": {
"description": "Returned if the request is invalid because:\n\n * no content is sent.\n * the issue type name exceeds 60 characters.\n * the avatar is not associated with this issue type."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the issue type is not found." },
"409": { "description": "Returned if the issue type name is in use." }
@@ -11916,8 +12839,12 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "400": { "description": "Returned if any issues cannot be updated with the alternative issue type." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if any issues cannot be updated with the alternative issue type."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the issue type is in use and an alternative issue type is not specified.\n * the issue type or alternative issue type is not found."
@@ -11955,12 +12882,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTypeDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueTypeDetails" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"description\":\"A task that needs to be done.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10299&avatarType=issuetype\\\",\",\"name\":\"Task\",\"subtask\":false,\"avatarId\":1,\"hierarchyLevel\":0},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/1\",\"id\":\"1\",\"description\":\"A problem with the software.\",\"iconUrl\":\"https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10316&avatarType=issuetype\\\",\",\"name\":\"Bug\",\"subtask\":false,\"avatarId\":10002,\"entityId\":\"9d7dd6f7-e8b6-4247-954b-7b2c9b2a5ba2\",\"hierarchyLevel\":0,\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the issue type is not found.\n * the user does not have the required permissions."
}
@@ -11972,7 +12904,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:issue-type:jira", "read:project-category:jira", "read:project:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:issue-type:jira",
+ "read:project-category:jira",
+ "read:project:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -12026,7 +12963,9 @@
"400": {
"description": "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image.\n * `cropSize` is missing.\n * the issue type ID is invalid."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the issue type is not found." }
},
@@ -12128,7 +13067,9 @@
}
},
"400": { "description": "Returned if the issue type ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the issue type or property is not found or the user does not have the required permissions."
}
@@ -12163,7 +13104,12 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": {}, "example": { "number": 5, "string": "string-value" } } },
+ "content": {
+ "application/json": {
+ "schema": {},
+ "example": { "number": 5, "string": "string-value" }
+ }
+ },
"required": true
},
"responses": {
@@ -12178,8 +13124,12 @@
"400": {
"description": "Returned if:\n\n * the issue type ID is invalid.\n * a property value is not provided.\n * the property value JSON content is invalid."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to modify the issue type." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to modify the issue type."
+ },
"404": {
"description": "Returned if:\n\n * the issue type is not found.\n * the user does not have the permission view the issue type."
}
@@ -12216,7 +13166,9 @@
"responses": {
"204": { "description": "Returned if the issue type property is deleted." },
"400": { "description": "Returned if the issue type ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the issue type or property is not found." }
},
@@ -12252,13 +13204,21 @@
"name": "id",
"in": "query",
"description": "The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "orderBy",
"in": "query",
"description": "[Order](#ordering) the results by a field:\n\n * `name` Sorts by issue type scheme name.\n * `id` Sorts by issue type scheme ID.",
- "schema": { "type": "string", "default": "id", "enum": ["name", "-name", "+name", "id", "-id", "+id"] }
+ "schema": {
+ "type": "string",
+ "default": "id",
+ "enum": ["name", "-name", "+name", "id", "-id", "+id"]
+ }
},
{
"name": "expand",
@@ -12284,7 +13244,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -12333,7 +13295,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12384,7 +13348,11 @@
"name": "issueTypeSchemeId",
"in": "query",
"description": "The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `issueTypeSchemeId=10000&issueTypeSchemeId=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -12398,7 +13366,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -12434,7 +13404,11 @@
"in": "query",
"description": "The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, `projectId=10000&projectId=10001`.",
"required": true,
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -12448,7 +13422,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -12487,7 +13463,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12509,7 +13487,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:issue-type-scheme:jira", "write:project:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:issue-type-scheme:jira", "write:project:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -12555,7 +13537,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12609,7 +13593,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12631,7 +13617,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:issue-type-scheme:jira", "write:project:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:issue-type-scheme:jira", "write:project:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -12674,7 +13664,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12739,7 +13731,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12802,7 +13796,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12853,7 +13849,11 @@
"name": "id",
"in": "query",
"description": "The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "queryString",
@@ -12865,7 +13865,11 @@
"name": "orderBy",
"in": "query",
"description": "[Order](#ordering) the results by a field:\n\n * `name` Sorts by issue type screen scheme name.\n * `id` Sorts by issue type screen scheme ID.",
- "schema": { "type": "string", "default": "id", "enum": ["name", "-name", "+name", "id", "-id", "+id"] }
+ "schema": {
+ "type": "string",
+ "default": "id",
+ "enum": ["name", "-name", "+name", "id", "-id", "+id"]
+ }
},
{
"name": "expand",
@@ -12885,7 +13889,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -12937,7 +13943,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -12996,7 +14004,11 @@
"name": "issueTypeScreenSchemeId",
"in": "query",
"description": "The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: `issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -13010,7 +14022,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -13046,7 +14060,11 @@
"in": "query",
"description": "The list of project IDs. To include multiple projects, separate IDs with ampersand: `projectId=10000&projectId=10001`.",
"required": true,
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
}
],
"responses": {
@@ -13060,7 +14078,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -13099,7 +14119,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -13168,7 +14190,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -13222,7 +14246,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." },
"404": {
"description": "Returned if the issue type screen scheme is not found.",
@@ -13237,7 +14263,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:issue-type-screen-scheme:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["delete:issue-type-screen-scheme:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -13286,7 +14316,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." },
"404": {
"description": "Returned if the issue type screen scheme, issue type, or screen scheme is not found.",
@@ -13352,7 +14384,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -13417,7 +14451,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -13484,7 +14520,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." }
},
"deprecated": false,
@@ -13633,7 +14671,11 @@
"schema": { "$ref": "#/components/schemas/IssuesAndJQLQueries" },
"example": {
"issueIds": [10001, 1000, 10042],
- "jqls": ["project = FOO", "issuetype = Bug", "summary ~ \"some text\" AND project in (FOO, BAR)"]
+ "jqls": [
+ "project = FOO",
+ "issuetype = Bug",
+ "summary ~ \"some text\" AND project in (FOO, BAR)"
+ ]
}
}
},
@@ -13706,7 +14748,9 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": { "description": "Returned if the authentication credentials are incorrect." }
},
@@ -13714,7 +14758,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field:jira", "validate:jql:jira", "read:jql:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field:jira", "validate:jql:jira", "read:jql:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "READ"
@@ -13754,13 +14802,19 @@
"400": {
"description": "Returned if at least one of the queries cannot be converted. For example, the JQL has invalid operators or invalid keywords, or the users in the query cannot be found."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-user"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:user:jira", "read:jql:jira", "validate:jql:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:user:jira", "read:jql:jira", "validate:jql:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -13779,8 +14833,14 @@
"example": {
"queries": [
{ "query": "project = 'Sample project'" },
- { "accountId": "5b10ac8d82e05b22cc7d4ef5", "query": "project = 'Sample project'" },
- { "accountId": "cda2aa1395ac195d951b3387", "query": "project = 'Sample project'" },
+ {
+ "accountId": "5b10ac8d82e05b22cc7d4ef5",
+ "query": "project = 'Sample project'"
+ },
+ {
+ "accountId": "cda2aa1395ac195d951b3387",
+ "query": "project = 'Sample project'"
+ },
{ "accountId": "5b10ac8d82e05b22cc7d4ef5", "query": "invalid query" }
]
}
@@ -13809,7 +14869,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -13884,14 +14946,24 @@
"description": "The key of project. Ignored if `projectId` is provided.",
"schema": { "type": "string" }
},
- { "name": "projectId", "in": "query", "description": "The ID of project.", "schema": { "type": "string" } },
+ {
+ "name": "projectId",
+ "in": "query",
+ "description": "The ID of project.",
+ "schema": { "type": "string" }
+ },
{
"name": "issueKey",
"in": "query",
"description": "The key of the issue. Ignored if `issueId` is provided.",
"schema": { "type": "string" }
},
- { "name": "issueId", "in": "query", "description": "The ID of the issue.", "schema": { "type": "string" } },
+ {
+ "name": "issueId",
+ "in": "query",
+ "description": "The ID of the issue.",
+ "schema": { "type": "string" }
+ },
{
"name": "permissions",
"in": "query",
@@ -13928,15 +15000,21 @@
},
"400": {
"description": "Returned if `permissions` is empty, contains an invalid key, or does not equal BROWSE\\_PROJECTS when commentId is provided.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": {
"description": "Returned if the project or issue is not found or the user does not have permission to view the project or issue.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -13968,7 +15046,9 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": { "type": "string" } } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the key is not provided or not found." }
},
"deprecated": false,
@@ -14006,7 +15086,9 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the key or value is not provided or invalid." }
},
"deprecated": false,
@@ -14033,7 +15115,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the key is not provided or not found." }
},
"deprecated": false,
@@ -14062,7 +15146,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
@@ -14094,7 +15180,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": true,
"security": [{ "basicAuth": [] }],
@@ -14111,7 +15199,9 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": true,
"security": [{ "basicAuth": [] }],
@@ -14142,7 +15232,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
@@ -14151,7 +15243,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:application-role:jira", "read:group:jira", "read:user:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:application-role:jira",
+ "read:group:jira",
+ "read:user:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -14193,7 +15290,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -14250,7 +15349,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the notification scheme is not found or the user does not have permission to view it."
}
@@ -14295,7 +15396,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -14323,7 +15426,11 @@
"globalPermissions": ["ADMINISTER"],
"accountId": "5b10a2844c20165700ede21g",
"projectPermissions": [
- { "projects": [10001], "permissions": ["EDIT_ISSUES"], "issues": [10010, 10011, 10012, 10013, 10014] }
+ {
+ "projects": [10001],
+ "permissions": ["EDIT_ISSUES"],
+ "issues": [10010, 10011, 10012, 10013, 10014]
+ }
]
}
}
@@ -14376,25 +15483,35 @@
"operationId": "getPermittedProjects",
"parameters": [],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionsKeysBean" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/PermissionsKeysBean" } }
+ },
"required": true
},
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermittedProjects" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/PermittedProjects" } }
+ }
},
"400": {
"description": "Returned if a project permission is not found.",
"content": { "application/json": {} }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": [] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": [] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:permission:jira", "read:project:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:permission:jira", "read:project:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -14423,7 +15540,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -14495,7 +15614,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or the feature is not available in the Jira plan."
}
@@ -14556,7 +15677,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the permission scheme is not found or the user does not have the necessary permission."
}
@@ -14636,7 +15759,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if:\n\n * the user does not have the necessary permission to update permission schemes.\n * the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be updated on free plans."
},
@@ -14682,7 +15807,9 @@
],
"responses": {
"204": { "description": "Returned if the permission scheme is deleted." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the permission scheme is not found." }
},
@@ -14726,7 +15853,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the permission schemes is not found or the user does not have the necessary permission."
}
@@ -14800,7 +15929,9 @@
"400": {
"description": "Returned if the value for expand is invalid or the same permission grant is present."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -14862,7 +15993,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the permission scheme or permission grant is not found or the user does not have the necessary permission."
}
@@ -14909,8 +16042,12 @@
],
"responses": {
"204": { "description": "Returned if the permission grant is deleted." },
- "400": { "description": "Returned if permission grant with the provided ID is not found." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if permission grant with the provided ID is not found."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -14990,7 +16127,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -15052,7 +16191,9 @@
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -15132,11 +16273,15 @@
},
"400": {
"description": "Returned if the request is not valid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
@@ -15199,7 +16344,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": true,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -15273,15 +16420,25 @@
}
}
},
- "400": { "description": "Returned if the request is not valid and the project could not be created." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to create projects." }
+ "400": {
+ "description": "Returned if the request is not valid and the project could not be created."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to create projects."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project:jira", "read:project:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project:jira", "read:project:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
}
@@ -15317,7 +16474,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -15403,7 +16562,11 @@
"name": "id",
"in": "query",
"description": "The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Up to 50 project IDs can be provided.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "keys",
@@ -15447,7 +16610,11 @@
"description": "EXPERIMENTAL. Filter results by project status:\n\n * `live` Search live projects.\n * `archived` Search archived projects.\n * `deleted` Search deleted projects, those in the recycle bin.",
"schema": {
"type": "array",
- "items": { "type": "string", "default": "live", "enum": ["live", "archived", "deleted"] }
+ "items": {
+ "type": "string",
+ "default": "live",
+ "enum": ["live", "archived", "deleted"]
+ }
}
},
{
@@ -15474,8 +16641,12 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "404": { "description": "Returned if no projects matching the search criteria are found." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "404": {
+ "description": "Returned if no projects matching the search criteria are found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -15514,7 +16685,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectType" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectType" }
+ },
"example": "[{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"jira.project.type.software.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"
}
}
@@ -15542,7 +16716,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectType" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectType" }
+ },
"example": "[{\"key\":\"business\",\"formattedKey\":\"Business\",\"descriptionI18nKey\":\"jira.project.type.business.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#FFFFFF\"},{\"key\":\"software\",\"formattedKey\":\"Software\",\"descriptionI18nKey\":\"jira.project.type.software.description\",\"icon\":\"PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+\",\"color\":\"#AAAAAA\"}]"
}
}
@@ -15569,7 +16746,10 @@
"in": "path",
"description": "The key of the project type.",
"required": true,
- "schema": { "type": "string", "enum": ["software", "service_desk", "business", "product_discovery"] }
+ "schema": {
+ "type": "string",
+ "enum": ["software", "service_desk", "business", "product_discovery"]
+ }
}
],
"responses": {
@@ -15606,7 +16786,10 @@
"in": "path",
"description": "The key of the project type.",
"required": true,
- "schema": { "type": "string", "enum": ["software", "service_desk", "business", "product_discovery"] }
+ "schema": {
+ "type": "string",
+ "enum": ["software", "service_desk", "business", "product_discovery"]
+ }
}
],
"responses": {
@@ -15619,7 +16802,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the project type is not accessible to the user." }
},
"deprecated": false,
@@ -15668,7 +16853,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view it."
}
@@ -15750,7 +16937,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if:\n\n * the user does not have the necessary permission to update project details.\n * the permission scheme is being changed and the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be changed on free plans."
},
@@ -15804,7 +16993,9 @@
],
"responses": {
"204": { "description": "Returned if the project is deleted." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to delete it."
}
@@ -15839,7 +17030,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permissions." },
"404": { "description": "Returned if the project is not found." }
},
@@ -15869,7 +17062,10 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/Avatar" }, "example": { "id": "10010" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/Avatar" },
+ "example": { "id": "10010" }
+ }
},
"required": true
},
@@ -15878,8 +17074,12 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to administer the project." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to administer the project."
+ },
"404": {
"description": "Returned if the project or avatar is not found or the user does not have permission to view the project."
}
@@ -15917,7 +17117,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the avatar is a system avatar or the user does not have permission to administer the project."
},
@@ -15981,7 +17183,9 @@
"400": {
"description": "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have permission to administer the project or an anonymous call is made to the operation."
},
@@ -15993,7 +17197,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project.avatar:jira", "read:avatar:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project.avatar:jira", "read:avatar:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
}
@@ -16023,7 +17231,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view the project."
}
@@ -16032,7 +17242,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:project.avatar:jira", "read:avatar:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:project.avatar:jira", "read:avatar:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -16102,7 +17316,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view it."
}
@@ -16147,12 +17363,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectComponent" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectComponent" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10000\",\"name\":\"Component 1\",\"description\":\"This is a Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"HSP\",\"projectId\":10000},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/component/10000\",\"id\":\"10050\",\"name\":\"PXA\",\"description\":\"This is a another Jira component\",\"lead\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"assigneeType\":\"PROJECT_LEAD\",\"assignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"realAssigneeType\":\"PROJECT_LEAD\",\"realAssignee\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\",\"key\":\"\",\"accountId\":\"5b10a2844c20165700ede21g\",\"accountType\":\"atlassian\",\"name\":\"\",\"avatarUrls\":{\"48x48\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48\",\"24x24\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24\",\"16x16\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16\",\"32x32\":\"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32\"},\"displayName\":\"Mia Krystof\",\"active\":false},\"isAssigneeTypeValid\":false,\"project\":\"PROJECTKEY\",\"projectId\":10000}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view it."
}
@@ -16195,10 +17416,16 @@
"responses": {
"303": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" }
+ }
+ }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have the necessary permission."
}
@@ -16207,7 +17434,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project:jira", "write:project.property:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project:jira", "write:project.property:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "PROJECT_ADMIN"
@@ -16239,7 +17470,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." },
"404": { "description": "Returned if the project is not found." }
},
@@ -16295,7 +17528,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the required permissions." },
"404": { "description": "Returned if the project or project feature is not found." }
},
@@ -16303,7 +17538,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project.feature:jira", "read:project.feature:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project.feature:jira", "read:project.feature:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
}
@@ -16335,7 +17574,9 @@
},
"400": { "description": "Returned if the request is not valid." },
"401": { "description": "Returned if the authentication credentials are incorrect." },
- "403": { "description": "Returned if the user does not have permission to view the project." },
+ "403": {
+ "description": "Returned if the user does not have permission to view the project."
+ },
"404": { "description": "Returned if the project is not found." }
},
"deprecated": false,
@@ -16394,7 +17635,9 @@
},
"400": { "description": "Returned if the request is not valid." },
"401": { "description": "Returned if the authentication credentials are incorrect." },
- "403": { "description": "Returned if the user does not have permission to view the project." },
+ "403": {
+ "description": "Returned if the user does not have permission to view the project."
+ },
"404": { "description": "Returned if the project or property is not found." }
},
"deprecated": false,
@@ -16427,7 +17670,12 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": {}, "example": { "number": 5, "string": "string-value" } } },
+ "content": {
+ "application/json": {
+ "schema": {},
+ "example": { "number": 5, "string": "string-value" }
+ }
+ },
"required": true
},
"responses": {
@@ -16441,7 +17689,9 @@
},
"400": { "description": "Returned if the project key or id is invalid." },
"401": { "description": "Returned if the authentication credentials are incorrect." },
- "403": { "description": "Returned if the user does not have permission to administer the project." },
+ "403": {
+ "description": "Returned if the user does not have permission to administer the project."
+ },
"404": { "description": "Returned if the project is not found." }
},
"deprecated": false,
@@ -16477,7 +17727,9 @@
"204": { "description": "Returned if the project property is deleted." },
"400": { "description": "Returned if the request is not valid." },
"401": { "description": "Returned if the authentication credentials are incorrect." },
- "403": { "description": "Returned if the user does not have permission to administer the project." },
+ "403": {
+ "description": "Returned if the user does not have permission to administer the project."
+ },
"404": { "description": "Returned if the project or property is not found." }
},
"deprecated": false,
@@ -16515,7 +17767,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have the necessary permission."
}
@@ -16567,7 +17821,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "object", "additionalProperties": { "type": "string", "format": "uri" } },
+ "schema": {
+ "type": "object",
+ "additionalProperties": { "type": "string", "format": "uri" }
+ },
"example": "{\"Administrators\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10002\",\"Users\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10001\",\"Developers\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10000\"}"
}
}
@@ -16627,7 +17884,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the project or project role is not found.\n * the user does not have administrative permission."
}
@@ -16870,19 +18129,28 @@
"description": "Whether the roles should be filtered to include only those the user is assigned to.",
"schema": { "type": "boolean", "default": false }
},
- { "name": "excludeConnectAddons", "in": "query", "schema": { "type": "boolean", "default": false } }
+ {
+ "name": "excludeConnectAddons",
+ "in": "query",
+ "schema": { "type": "boolean", "default": false }
+ }
],
"responses": {
"200": {
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRoleDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectRoleDetails" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"admin\":false,\"default\":true,\"roleConfigurable\":true,\"translatedName\":\"Developers\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or if the user does not have the necessary permissions for the project."
}
@@ -16894,7 +18162,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:project-category:jira", "read:project-role:jira", "read:project:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:project-category:jira",
+ "read:project-role:jira",
+ "read:project:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -16920,12 +18193,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IssueTypeWithStatus" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueTypeWithStatus" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/issueType/3\",\"id\":\"3\",\"name\":\"Task\",\"subtask\":false,\"statuses\":[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\"}]}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view it."
}
@@ -16976,7 +18254,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have permission to view it."
}
@@ -17177,9 +18457,15 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to read project." },
- "404": { "description": "Returned if the project or project's sender email address is not found." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to read project."
+ },
+ "404": {
+ "description": "Returned if the project or project's sender email address is not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }],
@@ -17219,9 +18505,15 @@
"description": "Returned if the project's sender email address is successfully set.",
"content": { "application/json": { "schema": {} } }
},
- "400": { "description": "Returned if the request is not valid, if the email address is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have permission to read project." },
+ "400": {
+ "description": "Returned if the request is not valid, if the email address is not valid."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have permission to read project."
+ },
"404": { "description": "Returned if the project is not found." }
},
"deprecated": false,
@@ -17260,7 +18552,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the project is not found or the user does not have the necessary permission."
}
@@ -17269,7 +18563,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:issue-type:jira", "read:issue-type-hierarchy:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:issue-type:jira", "read:issue-type-hierarchy:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -17300,7 +18598,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the project is visible to the user but the user doesn't have administrative permissions."
},
@@ -17353,8 +18653,12 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "404": { "description": "Returned if the project is not found or the user is not an administrator." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "404": {
+ "description": "Returned if the project is not found or the user is not an administrator."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -17410,7 +18714,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have permission to view the project's configuration."
},
@@ -17463,7 +18769,10 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/IdBean" }, "example": { "id": 10000 } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/IdBean" },
+ "example": { "id": 10000 }
+ }
},
"required": true
},
@@ -17477,7 +18786,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if:\n\n * the user does not have the necessary permission to edit the project's configuration.\n * the Jira instance is Jira Core Free or Jira Software Free. Permission schemes cannot be assigned to projects on free plans."
},
@@ -17558,12 +18869,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCategory" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectCategory" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\",\"id\":\"10000\",\"name\":\"FIRST\",\"description\":\"First Project Category\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10001\",\"id\":\"10001\",\"name\":\"SECOND\",\"description\":\"Second Project Category\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -17601,7 +18917,9 @@
"400": {
"description": "Returned if:\n\n * `name` is not provided or exceeds 255 characters.\n * `description` exceeds 1000 characters."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"409": { "description": "Returned if the project category name is in use." }
},
@@ -17643,7 +18961,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the project category is not found." }
},
"deprecated": false,
@@ -17660,7 +18980,12 @@
"description": "Updates a project category.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).",
"operationId": "updateProjectCategory",
"parameters": [
- { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": { "type": "integer", "format": "int64" }
+ }
],
"requestBody": {
"content": {
@@ -17684,7 +19009,9 @@
"400": {
"description": "Returned if:\n\n * `name` has been modified and exceeds 255 characters.\n * `description` has been modified and exceeds 1000 characters."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the project category is not found." }
},
@@ -17716,7 +19043,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the project category is not found." }
},
@@ -17783,7 +19112,9 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "type": "string" }, "example": "\"VPNE\"" } }
+ "content": {
+ "application/json": { "schema": { "type": "string" }, "example": "\"VPNE\"" }
+ }
},
"401": { "description": "Returned if the authentication credentials are incorrect." }
},
@@ -17811,7 +19142,10 @@
"200": {
"description": "Returned if the request is successful.",
"content": {
- "application/json": { "schema": { "type": "string" }, "example": "\"Valid Project Name Example\"" }
+ "application/json": {
+ "schema": { "type": "string" },
+ "example": "\"Valid Project Name Example\""
+ }
}
},
"400": { "description": "Returned if the request is invalid." },
@@ -17835,12 +19169,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Resolution" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/Resolution" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/resolution/1\",\"id\":\"10000\",\"description\":\"A fix for this issue is checked into the tree and tested.\",\"name\":\"Fixed\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/resolution/3\",\"id\":\"10001\",\"description\":\"This is what it is supposed to do.\",\"name\":\"Works as designed\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -17876,7 +19215,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the issue resolution value is not found." }
},
"deprecated": false,
@@ -17900,12 +19241,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRole" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ProjectRole" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360\",\"name\":\"Developers\",\"id\":10360,\"description\":\"A project role that represents developers in a project\",\"actors\":[{\"id\":10240,\"displayName\":\"jira-developers\",\"type\":\"atlassian-group-role-actor\",\"name\":\"jira-developers\",\"actorGroup\":{\"name\":\"jira-developers\",\"displayName\":\"jira-developers\",\"groupId\":\"952d12c3-5b5b-4d04-bb32-44d383afc4b2\"}},{\"id\":10241,\"displayName\":\"Mia Krystof\",\"type\":\"atlassian-user-role-actor\",\"actorUser\":{\"accountId\":\"5b10a2844c20165700ede21g\"}}],\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"10000\",\"key\":\"KEY\",\"name\":\"Next Gen Project\"}}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have administrative permissions." }
},
"deprecated": false,
@@ -17958,9 +19304,15 @@
"400": {
"description": "Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
- "409": { "description": "Returned if a project role with the provided name already exists." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
+ "409": {
+ "description": "Returned if a project role with the provided name already exists."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -18008,8 +19360,12 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18070,8 +19426,12 @@
"400": {
"description": "Returned if the request is not valid. The `name` cannot be empty or start or end with whitespace."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18131,8 +19491,12 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18180,8 +19544,12 @@
"400": {
"description": "Returned if the request is invalid or if the replacement project role is not found."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role being deleted is not found." },
"409": {
"description": "Returned if the project role being deleted is in use and a replacement project role is not specified in the request."
@@ -18222,8 +19590,12 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18279,8 +19651,12 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18347,8 +19723,12 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
- "403": { "description": "Returned if the user does not have administrative permissions." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
+ "403": {
+ "description": "Returned if the user does not have administrative permissions."
+ },
"404": { "description": "Returned if the project role is not found." }
},
"deprecated": false,
@@ -18395,7 +19775,11 @@
"name": "id",
"in": "query",
"description": "The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "queryString",
@@ -18430,7 +19814,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -18440,7 +19826,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:project:jira", "read:screen:jira", "read:avatar:jira", "read:project-category:jira"]
+ "scopes": [
+ "read:project:jira",
+ "read:screen:jira",
+ "read:avatar:jira",
+ "read:project-category:jira"
+ ]
}
],
"x-atlassian-connect-scope": "ADMIN"
@@ -18481,7 +19872,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -18531,9 +19924,13 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
- "404": { "description": "Returned if the field it not found or the field is already present." }
+ "404": {
+ "description": "Returned if the field it not found or the field is already present."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
@@ -18593,7 +19990,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -18605,7 +20004,9 @@
"404": {
"description": "Returned if the screen is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -18652,7 +20053,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -18664,7 +20067,9 @@
"404": {
"description": "Returned if the screen is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The screen was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -18698,11 +20103,16 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenableField" } }
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ScreenableField" }
+ }
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen is not found." }
},
@@ -18710,7 +20120,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:screen-field:jira", "read:screenable-field:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:screen-field:jira", "read:screenable-field:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -18741,12 +20155,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenableTab" } }
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ScreenableTab" }
+ }
}
}
},
"400": { "description": "Returned if the screen ID is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen is not found." }
},
@@ -18792,7 +20211,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen is not found." }
},
@@ -18800,7 +20221,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:screen-tab:jira", "write:screen-tab:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:screen-tab:jira", "write:screen-tab:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -18828,7 +20253,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenableTab" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ScreenableTab" } }
+ },
"required": true
},
"responses": {
@@ -18842,7 +20269,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen or screen tab is not found." }
},
@@ -18850,7 +20279,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:screen-tab:jira", "write:screen-tab:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:screen-tab:jira", "write:screen-tab:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -18877,7 +20310,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen or screen tab is not found." }
},
@@ -18923,11 +20358,16 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScreenableField" } }
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ScreenableField" }
+ }
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen or screen tab is not found." }
},
@@ -18980,7 +20420,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen, screen tab, or field is not found." }
},
@@ -19029,7 +20471,9 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the screen, screen tab, or field is not found." }
},
@@ -19072,7 +20516,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveFieldBean" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/MoveFieldBean" } }
+ },
"required": true
},
"responses": {
@@ -19081,7 +20527,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if the screen, screen tab, or field is not found or the field can't be moved to the requested position."
@@ -19131,9 +20579,13 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
- "404": { "description": "Returned if the screen or screen tab is not found or the position is invalid." }
+ "404": {
+ "description": "Returned if the screen or screen tab is not found or the position is invalid."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
@@ -19167,7 +20619,11 @@
"name": "id",
"in": "query",
"description": "The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.",
- "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }
+ "schema": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "integer", "format": "int64" }
+ }
},
{
"name": "expand",
@@ -19198,7 +20654,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -19250,7 +20708,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -19298,7 +20758,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/UpdateScreenSchemeDetails" },
- "example": { "screens": { "default": "10018", "create": "10019" }, "name": "Employee screen scheme v2" }
+ "example": {
+ "screens": { "default": "10018", "create": "10019" },
+ "name": "Employee screen scheme v2"
+ }
}
},
"required": true
@@ -19316,7 +20779,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -19367,7 +20832,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -19425,7 +20892,11 @@
"name": "validateQuery",
"in": "query",
"description": "Determines how to validate the JQL query and treat the validation results. Supported values are:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value.",
- "schema": { "type": "string", "default": "strict", "enum": ["strict", "warn", "none", "true", "false"] }
+ "schema": {
+ "type": "string",
+ "default": "strict",
+ "enum": ["strict", "warn", "none", "true", "false"]
+ }
},
{
"name": "fields",
@@ -19463,7 +20934,9 @@
}
},
"400": { "description": "Returned if the JQL query is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -19517,7 +20990,9 @@
}
},
"400": { "description": "Returned if the JQL query is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -19573,7 +21048,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:field:jira", "read:issue-security-level:jira", "read:project-role:jira", "read:user:jira"]
+ "scopes": [
+ "read:field:jira",
+ "read:issue-security-level:jira",
+ "read:project-role:jira",
+ "read:user:jira"
+ ]
}
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
@@ -19619,12 +21099,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnItem" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ColumnItem" }
+ },
"example": "[{\"label\":\"Key\",\"value\":\"issuekey\"},{\"label\":\"Summary\",\"value\":\"summary\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -19650,7 +21135,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if invalid parameters are passed." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if a navigable field value is not found." }
},
@@ -19671,12 +21158,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusDetails" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/StatusDetails" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/10000\",\"description\":\"The issue is currently being worked on.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/progress.gif\",\"name\":\"In Progress\",\"id\":\"10000\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"}},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/status/5\",\"description\":\"The issue is closed.\",\"iconUrl\":\"https://your-domain.atlassian.net/images/icons/closed.gif\",\"name\":\"Closed\",\"id\":\"5\",\"statusCategory\":{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -19712,7 +21204,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the status is not found.\n * the status is not associated with a workflow.\n * the user does not have the required permissions."
}
@@ -19738,12 +21232,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatusCategory" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/StatusCategory" }
+ },
"example": "[{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/1\",\"id\":1,\"key\":\"in-flight\",\"colorName\":\"yellow\",\"name\":\"In Progress\"},{\"self\":\"https://your-domain.atlassian.net/rest/api/3/statuscategory/9\",\"id\":9,\"key\":\"completed\",\"colorName\":\"green\"}]"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
@@ -19779,7 +21278,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the status category is not found." }
},
"deprecated": false,
@@ -19816,7 +21317,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JiraStatus" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/JiraStatus" }
+ },
"example": "[{\"id\":\"1000\",\"name\":\"Finished\",\"statusCategory\":\"DONE\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"1\"}},\"description\":\"The issue is resolved\",\"usages\":[{\"project\":{\"id\":\"1\"},\"issueTypes\":[\"10002\"]}]}]"
}
}
@@ -19848,7 +21352,12 @@
"schema": { "$ref": "#/components/schemas/StatusUpdateRequest" },
"example": {
"statuses": [
- { "name": "Finished", "description": "The issue is resolved", "id": "1000", "statusCategory": "DONE" }
+ {
+ "name": "Finished",
+ "description": "The issue is resolved",
+ "id": "1000",
+ "statusCategory": "DONE"
+ }
]
}
}
@@ -19894,7 +21403,13 @@
"schema": { "$ref": "#/components/schemas/StatusCreateRequest" },
"example": {
"scope": { "project": { "id": "1" }, "type": "PROJECT" },
- "statuses": [{ "name": "Finished", "description": "The issue is resolved", "statusCategory": "DONE" }]
+ "statuses": [
+ {
+ "name": "Finished",
+ "description": "The issue is resolved",
+ "statusCategory": "DONE"
+ }
+ ]
}
}
},
@@ -19905,7 +21420,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JiraStatus" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/JiraStatus" }
+ },
"example": "[{\"id\":\"1000\",\"name\":\"Finished\",\"statusCategory\":\"DONE\",\"scope\":{\"type\":\"PROJECT\",\"project\":{\"id\":\"1\"}},\"description\":\"The issue is resolved\",\"usages\":[]}]"
}
}
@@ -20065,7 +21583,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the task is not found." }
},
@@ -20100,19 +21620,27 @@
},
"400": {
"description": "Returned if cancellation of the task is not possible.",
- "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }
+ "content": {
+ "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
+ }
},
"401": {
"description": "Returned if the authentication credentials are incorrect or missing.",
- "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }
+ "content": {
+ "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
+ }
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
- "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }
+ "content": {
+ "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
+ }
},
"404": {
"description": "Returned if the task is not found.",
- "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }
+ "content": {
+ "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }
+ }
}
},
"deprecated": false,
@@ -20162,7 +21690,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the request is not from a Forge app." }
},
"deprecated": false,
@@ -20205,9 +21735,13 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the request is not from a Forge app." },
- "404": { "description": "Returned if a project or an issue type in the context are not found." }
+ "404": {
+ "description": "Returned if a project or an issue type in the context are not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -20253,7 +21787,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is not valid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the request is not from a Forge app." },
"404": {
"description": "Returned if the UI modification, a project or an issue type in the context are not found."
@@ -20283,7 +21819,9 @@
"description": "Returned if the UI modification is deleted.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the request is not from a Forge app." },
"404": { "description": "Returned if the UI modification is not found." }
},
@@ -20325,7 +21863,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found."
}
@@ -20392,7 +21932,9 @@
"400": {
"description": "Returned if:\n\n * an image isn't included in the request.\n * the image type is unsupported.\n * the crop parameters extend the crop area beyond the edge of the image."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permissions." },
"404": {
"description": "Returned if the avatar type is invalid, the associated item ID is missing, or the item is not found."
@@ -20402,7 +21944,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:avatar:jira", "read:avatar:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:avatar:jira", "read:avatar:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
}
@@ -20442,7 +21988,9 @@
"403": {
"description": "Returned if the user does not have permission to delete the avatar, the avatar is not deletable."
},
- "404": { "description": "Returned if the avatar type, associated item ID, or avatar ID is invalid." }
+ "404": {
+ "description": "Returned if the avatar type, associated item ID, or avatar ID is invalid."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }, {}],
@@ -20472,7 +22020,10 @@
"name": "size",
"in": "query",
"description": "The size of the avatar image. If not provided the default size is returned.",
- "schema": { "type": "string", "enum": ["xsmall", "small", "medium", "large", "xlarge"] },
+ "schema": {
+ "type": "string",
+ "enum": ["xsmall", "small", "medium", "large", "xlarge"]
+ },
"x-showInExample": "true"
},
{
@@ -20497,27 +22048,45 @@
"description": "Returned if the authentication credentials are incorrect.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"404": {
"description": "Returned if an avatar is not found or an avatar matching the requested size is not found.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
}
},
@@ -20558,7 +22127,10 @@
"name": "size",
"in": "query",
"description": "The size of the avatar image. If not provided the default size is returned.",
- "schema": { "type": "string", "enum": ["xsmall", "small", "medium", "large", "xlarge"] },
+ "schema": {
+ "type": "string",
+ "enum": ["xsmall", "small", "medium", "large", "xlarge"]
+ },
"x-showInExample": "true"
},
{
@@ -20583,36 +22155,60 @@
"description": "Returned if the request is not valid.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"401": {
"description": "Returned if the authentication credentials are incorrect.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"404": {
"description": "Returned if an avatar is not found or an avatar matching the requested size is not found.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
}
},
@@ -20653,7 +22249,10 @@
"name": "size",
"in": "query",
"description": "The size of the avatar image. If not provided the default size is returned.",
- "schema": { "type": "string", "enum": ["xsmall", "small", "medium", "large", "xlarge"] },
+ "schema": {
+ "type": "string",
+ "enum": ["xsmall", "small", "medium", "large", "xlarge"]
+ },
"x-showInExample": "true"
},
{
@@ -20678,36 +22277,60 @@
"description": "Returned if the request is not valid.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"401": {
"description": "Returned if the authentication credentials are incorrect.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
},
"404": {
"description": "Returned if an avatar is not found or an avatar matching the requested size is not found.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } },
- "image/png": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "image/svg+xml": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" },
- "*/*": { "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}" }
+ "image/png": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "image/svg+xml": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ },
+ "*/*": {
+ "example": "{\"errorMessages\":[\"Human readable error message\"],\"errors\":{}}"
+ }
}
}
},
@@ -20764,7 +22387,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the calling user does not have the *Browse users and groups* global permission."
},
@@ -20777,7 +22402,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:application-role:jira", "read:group:jira", "read:user:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:application-role:jira",
+ "read:group:jira",
+ "read:user:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "READ"
@@ -20808,8 +22438,12 @@
}
}
},
- "400": { "description": "Returned if the request is invalid or the number of licensed users is exceeded." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the request is invalid or the number of licensed users is exceeded."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -20847,7 +22481,9 @@
"responses": {
"204": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the user cannot be removed." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the user is not found." }
},
@@ -20916,7 +22552,9 @@
"400": {
"description": "Returned if:\n\n * `projectKeys` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if one or more of the projects is not found." },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
@@ -21018,7 +22656,9 @@
"400": {
"description": "Returned if:\n\n * `issueKey` or `project` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the project, issue, or transition is not found." },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
@@ -21100,7 +22740,9 @@
}
},
"400": { "description": "Returned if `accountID` is missing." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
@@ -21109,7 +22751,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:application-role:jira", "read:group:jira", "read:user:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:application-role:jira",
+ "read:group:jira",
+ "read:user:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-experimental": true,
@@ -21153,13 +22800,18 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserMigrationBean" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/UserMigrationBean" }
+ },
"example": "[{\"username\":\"mia\",\"accountId\":\"5b10a2844c20165700ede21g\"},{\"username\":\"emma\",\"accountId\":\"5b10ac8d82e05b22cc7d4ef5\"}]"
}
}
},
"400": { "description": "Returned if `key` or `username`" },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }],
@@ -21197,11 +22849,16 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnItem" } }
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/ColumnItem" }
+ }
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21211,7 +22868,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-user"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:user.columns:jira", "read:filter.column:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:user.columns:jira", "read:filter.column:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
},
@@ -21241,7 +22902,9 @@
"description": "Returned if the request is successful.",
"content": { "application/json": { "schema": {} } }
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21277,7 +22940,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
}
@@ -21337,13 +23002,21 @@
"in": "query",
"description": "The account IDs of the users for which emails are required. An `accountId` is an identifier that uniquely identifies the user across all Atlassian products. For example, `5b10ac8d82e05b22cc7d4ef5`. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).",
"required": true,
- "schema": { "maxLength": 128, "type": "array", "items": { "maxLength": 128, "type": "string" } }
+ "schema": {
+ "maxLength": 128,
+ "type": "array",
+ "items": { "maxLength": 128, "type": "string" }
+ }
}
],
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnrestrictedUserEmail" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/UnrestrictedUserEmail" }
+ }
+ }
},
"400": { "description": "Returned if the calling app is not approved to use this API." },
"401": {
@@ -21390,12 +23063,17 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupName" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/GroupName" }
+ },
"example": "{\"name\":\"jira-administrators\",\"groupId\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625\"}"
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the calling user does not have the *Browse users and groups* global permission."
},
@@ -21481,7 +23159,9 @@
"400": {
"description": "Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided.\n * `permissions` is empty or contains an invalid entry."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the issue or project is not found." },
"429": {
@@ -21547,7 +23227,11 @@
"schema": { "type": "array", "items": { "type": "string" } }
},
{ "name": "avatarSize", "in": "query", "schema": { "type": "string" } },
- { "name": "excludeConnectUsers", "in": "query", "schema": { "type": "boolean", "default": false } }
+ {
+ "name": "excludeConnectUsers",
+ "in": "query",
+ "schema": { "type": "boolean", "default": false }
+ }
],
"responses": {
"200": {
@@ -21560,7 +23244,9 @@
}
},
"400": { "description": "Returned if `exclude` and `excludeAccountIds` are provided." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
}
@@ -21612,7 +23298,9 @@
}
},
"400": { "description": "Returned if `accountId` is missing." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21685,7 +23373,9 @@
}
},
"400": { "description": "Returned if `accountId` is missing." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21743,7 +23433,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if `accountId` is missing." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21794,7 +23486,9 @@
"responses": {
"204": { "description": "Returned if the user property is deleted." },
"400": { "description": "Returned if `accountId` is missing." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission or is not accessing their user record."
},
@@ -21862,7 +23556,9 @@
"400": {
"description": "Returned if:\n\n * `accountId`, `query` or `property` is missing.\n * `query` and `accountId` are provided.\n * `property` parameter is not valid."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
}
@@ -21916,10 +23612,14 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageBeanUser" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/PageBeanUser" } }
+ }
},
"400": { "description": "Returned if the query is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"408": { "description": "Returned if the search is timed out." }
},
@@ -21977,10 +23677,14 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageBeanUserKey" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/PageBeanUserKey" } }
+ }
},
"400": { "description": "Returned if the query is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"408": { "description": "Returned if the search is timed out." }
},
@@ -22069,7 +23773,9 @@
"400": {
"description": "Returned if:\n\n * `issueKey` or `projectKey` is missing.\n * `query` or `accountId` is missing.\n * `query` and `accountId` are provided."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": { "description": "Returned if the issue or project is not found." },
"429": {
"description": "Returned if the rate limit is exceeded. User search endpoints share a collective rate limit for the tenant, in addition to Jira's normal rate limiting you may receive a rate limit for user search. Please respect the Retry-After header."
@@ -22127,7 +23833,9 @@
},
"400": { "description": "Returned if the request is invalid." },
"403": { "description": "Returned if the user doesn't have the necessary permission." },
- "409": { "description": "Returned if the request takes longer than 10 seconds or is interrupted." }
+ "409": {
+ "description": "Returned if the request takes longer than 10 seconds or is interrupted."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }, {}],
@@ -22136,7 +23844,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:user:jira", "read:application-role:jira", "read:avatar:jira", "read:group:jira"]
+ "scopes": [
+ "read:user:jira",
+ "read:application-role:jira",
+ "read:avatar:jira",
+ "read:group:jira"
+ ]
}
],
"x-atlassian-connect-scope": "INACCESSIBLE"
@@ -22174,7 +23887,9 @@
},
"400": { "description": "Returned if the request is invalid." },
"403": { "description": "Returned if the user doesn't have the necessary permission." },
- "409": { "description": "Returned if the request takes longer than 10 seconds or is interrupted." }
+ "409": {
+ "description": "Returned if the request takes longer than 10 seconds or is interrupted."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-user"] }, {}],
@@ -22183,7 +23898,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:user:jira", "read:application-role:jira", "read:avatar:jira", "read:group:jira"]
+ "scopes": [
+ "read:user:jira",
+ "read:application-role:jira",
+ "read:avatar:jira",
+ "read:group:jira"
+ ]
}
],
"x-atlassian-connect-scope": "INACCESSIBLE"
@@ -22223,7 +23943,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the project is not found.\n * the user does not have the required permissions."
}
@@ -22232,7 +23954,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project-version:jira", "read:project-version:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project-version:jira", "read:project-version:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
}
@@ -22268,7 +23994,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if the version is not found or the user does not have the necessary permission."
}
@@ -22335,7 +24063,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project-version:jira", "read:project-version:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project-version:jira", "read:project-version:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
},
@@ -22413,7 +24145,9 @@
"401": {
"description": "Returned if:\n\n * the authentication credentials are incorrect or missing.\n * the user does not have the required permissions."
},
- "404": { "description": "Returned if the version to be deleted or the version to merge to are not found." }
+ "404": {
+ "description": "Returned if the version to be deleted or the version to merge to are not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
@@ -22447,7 +24181,9 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/VersionMoveBean" },
- "example": { "after": "https://your-domain.atlassian.net/rest/api/~ver~/version/10000" }
+ "example": {
+ "after": "https://your-domain.atlassian.net/rest/api/~ver~/version/10000"
+ }
}
},
"required": true
@@ -22474,7 +24210,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-project"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-project"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:project-version:jira", "read:project-version:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:project-version:jira", "read:project-version:jira"]
+ }
],
"x-atlassian-connect-scope": "PROJECT_ADMIN"
}
@@ -22513,7 +24253,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }, {}],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:field:jira", "read:project-version:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:field:jira", "read:project-version:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -22535,7 +24279,9 @@
],
"requestBody": {
"content": {
- "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAndReplaceVersionBean" } }
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/DeleteAndReplaceVersionBean" }
+ }
},
"required": true
},
@@ -22545,7 +24291,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the version to delete is not found.\n * the user does not have the required permissions."
}
@@ -22588,7 +24336,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"404": {
"description": "Returned if:\n\n * the version is not found.\n * the user does not have the required permissions."
}
@@ -22634,17 +24384,25 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not an app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "manage:jira-webhook"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "manage:jira-webhook"] },
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "manage:jira-webhook"]
+ },
{ "state": "Beta", "scheme": "OAuth2", "scopes": ["read:webhook:jira", "read:jql:jira"] }
],
"x-atlassian-connect-scope": "READ"
@@ -22666,7 +24424,10 @@
"fieldIdsFilter": ["summary", "customfield_10029"],
"events": ["jira:issue_created", "jira:issue_updated"]
},
- { "jqlFilter": "project IN (PROJ, EXP) AND status = done", "events": ["jira:issue_deleted"] },
+ {
+ "jqlFilter": "project IN (PROJ, EXP) AND status = done",
+ "events": ["jira:issue_deleted"]
+ },
{
"jqlFilter": "project = PROJ",
"issuePropertyKeysFilter": ["my-issue-property-key"],
@@ -22691,17 +24452,25 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not an app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "manage:jira-webhook"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "manage:jira-webhook"] },
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "manage:jira-webhook"]
+ },
{
"state": "Beta",
"scheme": "OAuth2",
@@ -22729,17 +24498,25 @@
"202": { "description": "Returned if the request is successful." },
"400": {
"description": "Returned if the list of webhook IDs is missing.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not an app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "manage:jira-webhook"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "manage:jira-webhook"] },
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "manage:jira-webhook"]
+ },
{ "state": "Beta", "scheme": "OAuth2", "scopes": ["delete:webhook:jira"] }
],
"x-atlassian-connect-scope": "READ"
@@ -22777,17 +24554,25 @@
},
"400": {
"description": "400 response",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not a Connect app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "manage:jira-webhook"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "manage:jira-webhook"] },
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "manage:jira-webhook"]
+ },
{
"state": "Beta",
"scheme": "OAuth2",
@@ -22834,18 +24619,30 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not an app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work", "manage:jira-webhook"] }],
"x-atlassian-oauth2-scopes": [
- { "state": "Current", "scheme": "OAuth2", "scopes": ["read:jira-work", "manage:jira-webhook"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:webhook:jira", "read:webhook:jira"] }
+ {
+ "state": "Current",
+ "scheme": "OAuth2",
+ "scopes": ["read:jira-work", "manage:jira-webhook"]
+ },
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:webhook:jira", "read:webhook:jira"]
+ }
],
"x-atlassian-connect-scope": "READ"
}
@@ -22869,7 +24666,10 @@
"description": "Returned if the request is successful.",
"content": {
"application/json": {
- "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeprecatedWorkflow" } },
+ "schema": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/DeprecatedWorkflow" }
+ },
"example": "[{\"name\":\"classic workflow\",\"description\":\"A classic Jira workflow\",\"lastModifiedDate\":\"01-01-2011\",\"lastModifiedUser\":\"admin\",\"lastModifiedUserAccountId\":\"5b10a2844c20165700ede21g\",\"steps\":5,\"default\":true}]"
}
}
@@ -22883,7 +24683,12 @@
{
"state": "Beta",
"scheme": "OAuth2",
- "scopes": ["read:workflow:jira", "read:project:jira", "read:project-category:jira", "read:avatar:jira"]
+ "scopes": [
+ "read:workflow:jira",
+ "read:project:jira",
+ "read:project-category:jira",
+ "read:avatar:jira"
+ ]
}
],
"x-atlassian-connect-scope": "ADMIN"
@@ -22934,11 +24739,20 @@
"name": "Completed",
"rules": {
"postFunctions": [
- { "configuration": { "fieldId": "assignee" }, "type": "ClearFieldValuePostFunction" }
+ {
+ "configuration": { "fieldId": "assignee" },
+ "type": "ClearFieldValuePostFunction"
+ }
],
"validators": [
- { "configuration": { "parentStatuses": [{ "id": "3" }] }, "type": "ParentStatusValidator" },
- { "configuration": { "permissionKey": "ADMINISTER_PROJECTS" }, "type": "PermissionValidator" }
+ {
+ "configuration": { "parentStatuses": [{ "id": "3" }] },
+ "type": "ParentStatusValidator"
+ },
+ {
+ "configuration": { "permissionKey": "ADMINISTER_PROJECTS" },
+ "type": "PermissionValidator"
+ }
]
},
"to": "3",
@@ -22968,7 +24782,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -22990,7 +24806,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["write:workflow:jira", "read:workflow:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["write:workflow:jira", "read:workflow:jira"]
+ }
],
"x-experimental": true,
"x-atlassian-connect-scope": "ADMIN"
@@ -23079,11 +24899,15 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not a Connect app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"404": { "description": "Returned if the any transition rule type is not supported." }
},
@@ -23112,7 +24936,10 @@
],
"validators": [
{
- "configuration": { "disabled": false, "value": "{ \"shape\": \"square\" }" },
+ "configuration": {
+ "disabled": false,
+ "value": "{ \"shape\": \"square\" }"
+ },
"id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
}
],
@@ -23142,11 +24969,15 @@
},
"400": {
"description": "Returned if the request is invalid.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
},
"403": {
"description": "Returned if the caller is not a Connect app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -23202,7 +25033,9 @@
},
"403": {
"description": "Returned if the caller is not a Connect app.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } }
+ }
}
},
"deprecated": false,
@@ -23253,7 +25086,17 @@
"description": "[Order](#ordering) the results by a field:\n\n * `name` Sorts by workflow name.\n * `created` Sorts by create time.\n * `updated` Sorts by update time.",
"schema": {
"type": "string",
- "enum": ["name", "-name", "+name", "created", "-created", "+created", "updated", "+updated", "-updated"]
+ "enum": [
+ "name",
+ "-name",
+ "+name",
+ "created",
+ "-created",
+ "+created",
+ "updated",
+ "+updated",
+ "-updated"
+ ]
}
},
{
@@ -23273,7 +25116,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -23360,7 +25205,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have admin permission" },
"404": { "description": "Returned if the workflow transition or property is not found." }
},
@@ -23429,7 +25276,9 @@
"description": "Returned if no changes were made by the request. For example, attempting to update a property with its current value."
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow transition is not found." }
},
@@ -23498,8 +25347,12 @@
}
}
},
- "400": { "description": "Returned if a workflow property with the same key is present on the transition." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if a workflow property with the same key is present on the transition."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow transition is not found." }
},
@@ -23555,7 +25408,9 @@
"description": "Returned if no changes were made by the request. For example, trying to delete a property that cannot be found."
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow transition is not found." }
},
@@ -23593,7 +25448,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -23605,7 +25462,9 @@
"404": {
"description": "Returned if the workflow is not found.",
"content": {
- "application/json": { "example": "{\"errorMessages\":[\"The workflow was not found.\"],\"errors\":{}}" }
+ "application/json": {
+ "example": "{\"errorMessages\":[\"The workflow was not found.\"],\"errors\":{}}"
+ }
}
}
},
@@ -23649,7 +25508,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -23704,7 +25565,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -23769,7 +25632,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the necessary permission.",
"content": {
@@ -23829,7 +25694,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": {
"description": "Returned if the user does not have the required permissions.",
"content": {
@@ -23888,7 +25755,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -23953,7 +25822,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -23999,7 +25870,9 @@
"content": { "application/json": { "schema": {} } }
},
"400": { "description": "Returned if the scheme is active." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -24038,7 +25911,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." }
},
"deprecated": false,
@@ -24100,7 +25975,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -24108,7 +25985,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:workflow-scheme:jira", "read:workflow:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:workflow-scheme:jira", "read:workflow:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -24149,7 +26030,9 @@
"400": {
"description": "Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -24208,7 +26091,9 @@
"400": {
"description": "Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`."
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme is not found." }
},
@@ -24260,7 +26145,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft."
@@ -24332,7 +26219,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft."
@@ -24381,7 +26270,9 @@
],
"responses": {
"204": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission.." },
"404": {
"description": "Returned if:\n\n * the original active workflow scheme is not found.\n * the original active workflow scheme does not have a draft."
@@ -24421,7 +26312,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission.." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft."
@@ -24431,7 +26324,11 @@
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
"x-atlassian-oauth2-scopes": [
{ "state": "Current", "scheme": "OAuth2", "scopes": ["manage:jira-configuration"] },
- { "state": "Beta", "scheme": "OAuth2", "scopes": ["read:workflow-scheme:jira", "read:workflow:jira"] }
+ {
+ "state": "Beta",
+ "scheme": "OAuth2",
+ "scopes": ["read:workflow-scheme:jira", "read:workflow:jira"]
+ }
],
"x-atlassian-connect-scope": "ADMIN"
},
@@ -24470,7 +26367,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft."
@@ -24523,7 +26422,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft."
@@ -24585,7 +26486,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -24643,7 +26546,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -24701,7 +26606,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -24768,10 +26675,16 @@
"required": true
},
"responses": {
- "204": { "description": "Returned if the request is only for validation and is successful." },
+ "204": {
+ "description": "Returned if the request is only for validation and is successful."
+ },
"303": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" } } }
+ "content": {
+ "application/json": {
+ "schema": { "$ref": "#/components/schemas/TaskProgressBeanObject" }
+ }
+ }
},
"400": {
"description": "Returned if the request is invalid.",
@@ -24781,7 +26694,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of these are true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * A new status in the draft workflow scheme is not found.",
@@ -24833,7 +26748,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if either the workflow scheme or workflow (if specified) is not found. session."
@@ -24876,7 +26793,11 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/IssueTypesWorkflowMapping" },
- "example": { "workflow": "jira", "updateDraftIfNeeded": true, "issueTypes": ["10000"] }
+ "example": {
+ "workflow": "jira",
+ "updateDraftIfNeeded": true,
+ "issueTypes": ["10000"]
+ }
}
},
"required": true
@@ -24892,7 +26813,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified."
@@ -24944,7 +26867,9 @@
],
"responses": {
"200": { "description": "Returned if the request is successful." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow scheme does not have a draft.\n * The workflow is not found.\n * The workflow is not specified."
@@ -24997,7 +26922,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -25054,8 +26981,12 @@
}
}
},
- "400": { "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -25119,8 +27050,12 @@
}
}
},
- "400": { "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": { "description": "Returned if the workflow scheme or issue type is not found." }
},
@@ -25185,9 +27120,13 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
- "404": { "description": "Returned if either the workflow scheme or workflow is not found." }
+ "404": {
+ "description": "Returned if either the workflow scheme or workflow is not found."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["manage:jira-configuration"] }],
@@ -25226,7 +27165,11 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/IssueTypesWorkflowMapping" },
- "example": { "workflow": "jira", "updateDraftIfNeeded": true, "issueTypes": ["10000"] }
+ "example": {
+ "workflow": "jira",
+ "updateDraftIfNeeded": true,
+ "issueTypes": ["10000"]
+ }
}
},
"required": true
@@ -25242,7 +27185,9 @@
}
},
"400": { "description": "Returned if the request is invalid." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified."
@@ -25300,8 +27245,12 @@
],
"responses": {
"200": { "description": "Returned if the request is successful." },
- "400": { "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." },
+ "400": {
+ "description": "Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ },
"403": { "description": "Returned if the user does not have the necessary permission." },
"404": {
"description": "Returned if any of the following is true:\n\n * The workflow scheme is not found.\n * The workflow is not found.\n * The workflow is not specified."
@@ -25340,7 +27289,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -25389,8 +27340,12 @@
}
}
},
- "400": { "description": "Returned if the request contains more than 1000 worklog IDs or is empty." },
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "400": {
+ "description": "Returned if the request contains more than 1000 worklog IDs or is empty."
+ },
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -25443,7 +27398,9 @@
}
}
},
- "401": { "description": "Returned if the authentication credentials are incorrect or missing." }
+ "401": {
+ "description": "Returned if the authentication credentials are incorrect or missing."
+ }
},
"deprecated": false,
"security": [{ "basicAuth": [] }, { "OAuth2": ["read:jira-work"] }],
@@ -25495,7 +27452,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "Access to this resource must be authenticated as an app.", "statusCode": 401 }
+ "example": {
+ "message": "Access to this resource must be authenticated as an app.",
+ "statusCode": 401
+ }
}
}
}
@@ -25545,7 +27505,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "The property key cannot be longer than 127 characters.", "statusCode": 400 }
+ "example": {
+ "message": "The property key cannot be longer than 127 characters.",
+ "statusCode": 400
+ }
}
}
},
@@ -25554,7 +27517,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "Access to this resource must be authenticated as an app.", "statusCode": 401 }
+ "example": {
+ "message": "Access to this resource must be authenticated as an app.",
+ "statusCode": 401
+ }
}
}
},
@@ -25617,7 +27583,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "The property key cannot be longer than 127 characters.", "statusCode": 400 }
+ "example": {
+ "message": "The property key cannot be longer than 127 characters.",
+ "statusCode": 400
+ }
}
}
},
@@ -25626,7 +27595,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "Access to this resource must be authenticated as an app.", "statusCode": 401 }
+ "example": {
+ "message": "Access to this resource must be authenticated as an app.",
+ "statusCode": 401
+ }
}
}
}
@@ -25662,7 +27634,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "The property key cannot be longer than 127 characters.", "statusCode": 400 }
+ "example": {
+ "message": "The property key cannot be longer than 127 characters.",
+ "statusCode": 400
+ }
}
}
},
@@ -25671,7 +27646,10 @@
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/OperationMessage" },
- "example": { "message": "Access to this resource must be authenticated as an app.", "statusCode": 401 }
+ "example": {
+ "message": "Access to this resource must be authenticated as an app.",
+ "statusCode": 401
+ }
}
}
},
@@ -25699,7 +27677,9 @@
"responses": {
"200": {
"description": "Returned if the request is successful.",
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectModules" } } }
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ConnectModules" } }
+ }
},
"401": {
"description": "Returned if the call is not from a Connect app.",
@@ -25722,7 +27702,9 @@
"operationId": "DynamicModulesResource.registerModules_post",
"parameters": [],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectModules" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/ConnectModules" } }
+ },
"required": true
},
"responses": {
@@ -25804,10 +27786,30 @@
"schema": { "$ref": "#/components/schemas/ConnectCustomFieldValues" },
"example": {
"updateValueList": [
- { "_type": "StringIssueField", "issueID": 10001, "fieldID": 10076, "string": "new string value" },
- { "_type": "TextIssueField", "issueID": 10002, "fieldID": 10077, "text": "new text value" },
- { "_type": "SingleSelectIssueField", "issueID": 10003, "fieldID": 10078, "optionID": "1" },
- { "_type": "MultiSelectIssueField", "issueID": 10004, "fieldID": 10079, "optionID": "2" },
+ {
+ "_type": "StringIssueField",
+ "issueID": 10001,
+ "fieldID": 10076,
+ "string": "new string value"
+ },
+ {
+ "_type": "TextIssueField",
+ "issueID": 10002,
+ "fieldID": 10077,
+ "text": "new text value"
+ },
+ {
+ "_type": "SingleSelectIssueField",
+ "issueID": 10003,
+ "fieldID": 10078,
+ "optionID": "1"
+ },
+ {
+ "_type": "MultiSelectIssueField",
+ "issueID": 10004,
+ "fieldID": 10079,
+ "optionID": "2"
+ },
{
"_type": "RichTextIssueField",
"issueID": 10005,
@@ -25886,7 +27888,9 @@
"responses": {
"200": { "description": "Returned if the request is successful." },
"400": { "description": "Returned if the request is not valid." },
- "403": { "description": "Returned if the authorisation credentials are incorrect or missing." }
+ "403": {
+ "description": "Returned if the authorisation credentials are incorrect or missing."
+ }
},
"x-atlassian-connect-scope": "NONE"
}
@@ -25907,7 +27911,9 @@
}
],
"requestBody": {
- "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRulesSearch" } } },
+ "content": {
+ "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRulesSearch" } }
+ },
"required": true
},
"responses": {
@@ -25953,7 +27959,9 @@
}
},
"400": { "description": "Returned if the request is not valid." },
- "403": { "description": "Returned if the authorisation credentials are incorrect or missing." }
+ "403": {
+ "description": "Returned if the authorisation credentials are incorrect or missing."
+ }
},
"x-atlassian-connect-scope": "NONE"
}
@@ -25964,7 +27972,12 @@
"PageBeanUserKey": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -25989,7 +28002,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -26079,10 +28096,26 @@
"AvatarUrlsBean": {
"type": "object",
"properties": {
- "16x16": { "type": "string", "description": "The URL of the item's 16x16 pixel avatar.", "format": "uri" },
- "24x24": { "type": "string", "description": "The URL of the item's 24x24 pixel avatar.", "format": "uri" },
- "32x32": { "type": "string", "description": "The URL of the item's 32x32 pixel avatar.", "format": "uri" },
- "48x48": { "type": "string", "description": "The URL of the item's 48x48 pixel avatar.", "format": "uri" }
+ "16x16": {
+ "type": "string",
+ "description": "The URL of the item's 16x16 pixel avatar.",
+ "format": "uri"
+ },
+ "24x24": {
+ "type": "string",
+ "description": "The URL of the item's 24x24 pixel avatar.",
+ "format": "uri"
+ },
+ "32x32": {
+ "type": "string",
+ "description": "The URL of the item's 32x32 pixel avatar.",
+ "format": "uri"
+ },
+ "48x48": {
+ "type": "string",
+ "description": "The URL of the item's 48x48 pixel avatar.",
+ "format": "uri"
+ }
},
"additionalProperties": false
},
@@ -26110,7 +28143,12 @@
"PageBeanUser": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -26135,7 +28173,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -26153,7 +28195,11 @@
"items": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationRole" } },
"pagingCallback": { "$ref": "#/components/schemas/ListWrapperCallbackApplicationRole" },
"callback": { "$ref": "#/components/schemas/ListWrapperCallbackApplicationRole" },
- "max-results": { "type": "integer", "format": "int32", "xml": { "name": "max-results", "attribute": true } }
+ "max-results": {
+ "type": "integer",
+ "format": "int32",
+ "xml": { "name": "max-results", "attribute": true }
+ }
},
"additionalProperties": false,
"xml": { "name": "list" }
@@ -26165,7 +28211,11 @@
"items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupName" } },
"pagingCallback": { "$ref": "#/components/schemas/ListWrapperCallbackGroupName" },
"callback": { "$ref": "#/components/schemas/ListWrapperCallbackGroupName" },
- "max-results": { "type": "integer", "format": "int32", "xml": { "name": "max-results", "attribute": true } }
+ "max-results": {
+ "type": "integer",
+ "format": "int32",
+ "xml": { "name": "max-results", "attribute": true }
+ }
},
"additionalProperties": false,
"xml": { "name": "list" }
@@ -26173,7 +28223,12 @@
"User": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the user.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the user.",
+ "format": "uri",
+ "readOnly": true
+ },
"key": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
@@ -26208,7 +28263,11 @@
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"readOnly": true
},
- "active": { "type": "boolean", "description": "Whether the user is active.", "readOnly": true },
+ "active": {
+ "type": "boolean",
+ "description": "Whether the user is active.",
+ "readOnly": true
+ },
"timeZone": {
"type": "string",
"description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.",
@@ -26243,17 +28302,41 @@
"ChangeDetails": {
"type": "object",
"properties": {
- "field": { "type": "string", "description": "The name of the field changed.", "readOnly": true },
- "fieldtype": { "type": "string", "description": "The type of the field changed.", "readOnly": true },
- "fieldId": { "type": "string", "description": "The ID of the field changed.", "readOnly": true },
- "from": { "type": "string", "description": "The details of the original value.", "readOnly": true },
+ "field": {
+ "type": "string",
+ "description": "The name of the field changed.",
+ "readOnly": true
+ },
+ "fieldtype": {
+ "type": "string",
+ "description": "The type of the field changed.",
+ "readOnly": true
+ },
+ "fieldId": {
+ "type": "string",
+ "description": "The ID of the field changed.",
+ "readOnly": true
+ },
+ "from": {
+ "type": "string",
+ "description": "The details of the original value.",
+ "readOnly": true
+ },
"fromString": {
"type": "string",
"description": "The details of the original value as a string.",
"readOnly": true
},
- "to": { "type": "string", "description": "The details of the new value.", "readOnly": true },
- "toString": { "type": "string", "description": "The details of the new value as a string.", "readOnly": true }
+ "to": {
+ "type": "string",
+ "description": "The details of the new value.",
+ "readOnly": true
+ },
+ "toString": {
+ "type": "string",
+ "description": "The details of the new value as a string.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "A change item."
@@ -26292,7 +28375,11 @@
"required": ["key", "name", "operations", "required", "schema"],
"type": "object",
"properties": {
- "required": { "type": "boolean", "description": "Whether the field is required.", "readOnly": true },
+ "required": {
+ "type": "boolean",
+ "description": "Whether the field is required.",
+ "readOnly": true
+ },
"schema": {
"description": "The data type of the field.",
"readOnly": true,
@@ -26338,9 +28425,18 @@
"type": "object",
"properties": {
"type": { "type": "string", "description": "The type of the history record." },
- "description": { "type": "string", "description": "The description of the history record." },
- "descriptionKey": { "type": "string", "description": "The description key of the history record." },
- "activityDescription": { "type": "string", "description": "The activity described in the history record." },
+ "description": {
+ "type": "string",
+ "description": "The description of the history record."
+ },
+ "descriptionKey": {
+ "type": "string",
+ "description": "The description key of the history record."
+ },
+ "activityDescription": {
+ "type": "string",
+ "description": "The activity described in the history record."
+ },
"activityDescriptionKey": {
"type": "string",
"description": "The key of the activity described in the history record."
@@ -26377,7 +28473,10 @@
"HistoryMetadataParticipant": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the user or system associated with a history record." },
+ "id": {
+ "type": "string",
+ "description": "The ID of the user or system associated with a history record."
+ },
"displayName": {
"type": "string",
"description": "The display name of the user or system associated with a history record."
@@ -26394,7 +28493,10 @@
"type": "string",
"description": "The URL to an avatar for the user or system associated with a history record."
},
- "url": { "type": "string", "description": "The URL of the user or system associated with a history record." }
+ "url": {
+ "type": "string",
+ "description": "The URL of the user or system associated with a history record."
+ }
},
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item."
@@ -26404,7 +28506,11 @@
"properties": {
"excluded": { "uniqueItems": true, "type": "array", "items": { "type": "string" } },
"included": { "uniqueItems": true, "type": "array", "items": { "type": "string" } },
- "actuallyIncluded": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }
+ "actuallyIncluded": {
+ "uniqueItems": true,
+ "type": "array",
+ "items": { "type": "string" }
+ }
},
"additionalProperties": false
},
@@ -26494,7 +28600,11 @@
"type": "string",
"description": "The ID of the issue transition. Required when specifying a transition to undertake."
},
- "name": { "type": "string", "description": "The name of the issue transition.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue transition.",
+ "readOnly": true
+ },
"to": {
"description": "Details of the issue status after the transition.",
"readOnly": true,
@@ -26558,7 +28668,11 @@
"required": ["type"],
"type": "object",
"properties": {
- "type": { "type": "string", "description": "The data type of the field.", "readOnly": true },
+ "type": {
+ "type": "string",
+ "description": "The data type of the field.",
+ "readOnly": true
+ },
"items": {
"type": "string",
"description": "When the data type is an array, the name of the field items within the array.",
@@ -26719,20 +28833,32 @@
"StatusCategory": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the status category.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the status category.",
+ "readOnly": true
+ },
"id": {
"type": "integer",
"description": "The ID of the status category.",
"format": "int64",
"readOnly": true
},
- "key": { "type": "string", "description": "The key of the status category.", "readOnly": true },
+ "key": {
+ "type": "string",
+ "description": "The key of the status category.",
+ "readOnly": true
+ },
"colorName": {
"type": "string",
"description": "The name of the color used to represent the status category.",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the status category.", "readOnly": true }
+ "name": {
+ "type": "string",
+ "description": "The name of the status category.",
+ "readOnly": true
+ }
},
"additionalProperties": true,
"description": "A status category."
@@ -26741,7 +28867,11 @@
"type": "object",
"properties": {
"self": { "type": "string", "description": "The URL of the status.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the status.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the status.",
+ "readOnly": true
+ },
"iconUrl": {
"type": "string",
"description": "The URL of the icon used to represent the status.",
@@ -26792,7 +28922,11 @@
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true
},
- "active": { "type": "boolean", "description": "Whether the user is active.", "readOnly": true },
+ "active": {
+ "type": "boolean",
+ "description": "Whether the user is active.",
+ "readOnly": true
+ },
"timeZone": {
"type": "string",
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
@@ -26810,7 +28944,10 @@
"SearchRequestBean": {
"type": "object",
"properties": {
- "jql": { "type": "string", "description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression." },
+ "jql": {
+ "type": "string",
+ "description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression."
+ },
"startAt": {
"type": "integer",
"description": "The index of the first item to return in the page of results (page offset). The base index is `0`.",
@@ -26872,7 +29009,10 @@
"description": "Whether the field provide auto-complete suggestions.",
"enum": ["true", "false"]
},
- "cfid": { "type": "string", "description": "If the item is a custom field, the ID of the custom field." },
+ "cfid": {
+ "type": "string",
+ "description": "If the item is a custom field, the ID of the custom field."
+ },
"operators": {
"type": "array",
"description": "The valid search operators for the field.",
@@ -27014,8 +29154,17 @@
"required": ["name"],
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the filter.", "format": "uri", "readOnly": true },
- "id": { "type": "string", "description": "The unique identifier for the filter.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the filter.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier for the filter.",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the filter. Must be unique." },
"description": { "type": "string", "description": "A description of the filter." },
"owner": {
@@ -27039,7 +29188,10 @@
"format": "uri",
"readOnly": true
},
- "favourite": { "type": "boolean", "description": "Whether the filter is selected as a favorite." },
+ "favourite": {
+ "type": "boolean",
+ "description": "Whether the filter is selected as a favorite."
+ },
"favouritedCount": {
"type": "integer",
"description": "The count of how many users have selected this filter as a favorite, including the filter owner.",
@@ -27157,11 +29309,27 @@
"IssueTypeDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of these issue type details.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of these issue type details.",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the issue type.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the issue type.", "readOnly": true },
- "iconUrl": { "type": "string", "description": "The URL of the issue type's avatar.", "readOnly": true },
- "name": { "type": "string", "description": "The name of the issue type.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the issue type.",
+ "readOnly": true
+ },
+ "iconUrl": {
+ "type": "string",
+ "description": "The URL of the issue type's avatar.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue type.",
+ "readOnly": true
+ },
"subtask": {
"type": "boolean",
"description": "Whether this issue type is used to create subtasks.",
@@ -27211,7 +29379,11 @@
},
"id": { "type": "string", "description": "The ID of the project." },
"key": { "type": "string", "description": "The key of the project.", "readOnly": true },
- "description": { "type": "string", "description": "A brief description of the project.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "A brief description of the project.",
+ "readOnly": true
+ },
"lead": {
"description": "The username of the project lead.",
"readOnly": true,
@@ -27234,7 +29406,10 @@
"description": "A link to information about this project, such as project documentation.",
"readOnly": true
},
- "email": { "type": "string", "description": "An email address associated with the project." },
+ "email": {
+ "type": "string",
+ "description": "An email address associated with the project."
+ },
"assigneeType": {
"type": "string",
"description": "The default assignee when creating issues for this project.",
@@ -27270,15 +29445,26 @@
"readOnly": true,
"enum": ["software", "service_desk", "business"]
},
- "simplified": { "type": "boolean", "description": "Whether the project is simplified.", "readOnly": true },
+ "simplified": {
+ "type": "boolean",
+ "description": "Whether the project is simplified.",
+ "readOnly": true
+ },
"style": {
"type": "string",
"description": "The type of the project.",
"readOnly": true,
"enum": ["classic", "next-gen"]
},
- "favourite": { "type": "boolean", "description": "Whether the project is selected as a favorite." },
- "isPrivate": { "type": "boolean", "description": "Whether the project is private.", "readOnly": true },
+ "favourite": {
+ "type": "boolean",
+ "description": "Whether the project is selected as a favorite."
+ },
+ "isPrivate": {
+ "type": "boolean",
+ "description": "Whether the project is private.",
+ "readOnly": true
+ },
"issueTypeHierarchy": {
"description": "The issue type hierarchy for the project.",
"readOnly": true,
@@ -27328,7 +29514,11 @@
"readOnly": true,
"allOf": [{ "$ref": "#/components/schemas/User" }]
},
- "archived": { "type": "boolean", "description": "Whether the project is archived.", "readOnly": true },
+ "archived": {
+ "type": "boolean",
+ "description": "Whether the project is archived.",
+ "readOnly": true
+ },
"archivedDate": {
"type": "string",
"description": "The date when the project was archived.",
@@ -27359,12 +29549,19 @@
"format": "uri",
"readOnly": true
},
- "id": { "type": "string", "description": "The ID of the project category.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the project category.",
+ "readOnly": true
+ },
"name": {
"type": "string",
"description": "The name of the project category. Required on create, optional on update."
},
- "description": { "type": "string", "description": "The description of the project category." }
+ "description": {
+ "type": "string",
+ "description": "The description of the project category."
+ }
},
"additionalProperties": false,
"description": "A project category."
@@ -27372,8 +29569,17 @@
"ProjectComponent": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the component.", "format": "uri", "readOnly": true },
- "id": { "type": "string", "description": "The unique identifier for the component.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the component.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier for the component.",
+ "readOnly": true
+ },
"name": {
"type": "string",
"description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."
@@ -27441,7 +29647,11 @@
"ProjectDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the project details.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the project details.",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the project." },
"key": { "type": "string", "description": "The key of the project.", "readOnly": true },
"name": { "type": "string", "description": "The name of the project.", "readOnly": true },
@@ -27534,7 +29744,11 @@
"format": "int64",
"readOnly": true
},
- "description": { "type": "string", "description": "The description of the project role.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the project role.",
+ "readOnly": true
+ },
"actors": {
"type": "array",
"description": "The list of users who act in this role.",
@@ -27546,8 +29760,14 @@
"readOnly": true,
"allOf": [{ "$ref": "#/components/schemas/Scope" }]
},
- "translatedName": { "type": "string", "description": "The translated name of the project role." },
- "currentUserRole": { "type": "boolean", "description": "Whether the calling user is part of this role." },
+ "translatedName": {
+ "type": "string",
+ "description": "The translated name of the project role."
+ },
+ "currentUserRole": {
+ "type": "boolean",
+ "description": "Whether the calling user is part of this role."
+ },
"default": {
"type": "boolean",
"description": "Whether this role is the default role for the project",
@@ -27596,7 +29816,12 @@
"RoleActor": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the role actor.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the role actor.",
+ "format": "int64",
+ "readOnly": true
+ },
"displayName": {
"type": "string",
"description": "The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name.",
@@ -27619,8 +29844,14 @@
"format": "uri",
"readOnly": true
},
- "actorUser": { "readOnly": true, "allOf": [{ "$ref": "#/components/schemas/ProjectRoleUser" }] },
- "actorGroup": { "readOnly": true, "allOf": [{ "$ref": "#/components/schemas/ProjectRoleGroup" }] }
+ "actorUser": {
+ "readOnly": true,
+ "allOf": [{ "$ref": "#/components/schemas/ProjectRoleUser" }]
+ },
+ "actorGroup": {
+ "readOnly": true,
+ "allOf": [{ "$ref": "#/components/schemas/ProjectRoleGroup" }]
+ }
},
"additionalProperties": false,
"description": "Details about a user assigned to a project role.",
@@ -27720,7 +29951,11 @@
"description": "The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/).",
"format": "int64"
},
- "level": { "type": "integer", "description": "The level of this item in the hierarchy.", "format": "int32" },
+ "level": {
+ "type": "integer",
+ "description": "The level of this item in the hierarchy.",
+ "format": "int32"
+ },
"issueTypeIds": {
"type": "array",
"description": "The issue types available in this hierarchy level.",
@@ -27746,10 +29981,26 @@
"UpdatedProjectCategory": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the project category.", "readOnly": true },
- "id": { "type": "string", "description": "The ID of the project category.", "readOnly": true },
- "description": { "type": "string", "description": "The name of the project category.", "readOnly": true },
- "name": { "type": "string", "description": "The description of the project category.", "readOnly": true }
+ "self": {
+ "type": "string",
+ "description": "The URL of the project category.",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the project category.",
+ "readOnly": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The name of the project category.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The description of the project category.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "A project category."
@@ -27786,10 +30037,26 @@
"UserBeanAvatarUrls": {
"type": "object",
"properties": {
- "16x16": { "type": "string", "description": "The URL of the user's 16x16 pixel avatar.", "format": "uri" },
- "24x24": { "type": "string", "description": "The URL of the user's 24x24 pixel avatar.", "format": "uri" },
- "32x32": { "type": "string", "description": "The URL of the user's 32x32 pixel avatar.", "format": "uri" },
- "48x48": { "type": "string", "description": "The URL of the user's 48x48 pixel avatar.", "format": "uri" }
+ "16x16": {
+ "type": "string",
+ "description": "The URL of the user's 16x16 pixel avatar.",
+ "format": "uri"
+ },
+ "24x24": {
+ "type": "string",
+ "description": "The URL of the user's 24x24 pixel avatar.",
+ "format": "uri"
+ },
+ "32x32": {
+ "type": "string",
+ "description": "The URL of the user's 32x32 pixel avatar.",
+ "format": "uri"
+ },
+ "48x48": {
+ "type": "string",
+ "description": "The URL of the user's 48x48 pixel avatar.",
+ "format": "uri"
+ }
},
"additionalProperties": false
},
@@ -27842,7 +30109,12 @@
"description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n\nOptional for create and update.",
"xml": { "attribute": true }
},
- "self": { "type": "string", "description": "The URL of the version.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the version.",
+ "format": "uri",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the version.", "readOnly": true },
"description": {
"type": "string",
@@ -27870,7 +30142,11 @@
"description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.",
"format": "date"
},
- "overdue": { "type": "boolean", "description": "Indicates that the version is overdue.", "readOnly": true },
+ "overdue": {
+ "type": "boolean",
+ "description": "Indicates that the version is overdue.",
+ "readOnly": true
+ },
"userStartDate": {
"type": "string",
"description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format.",
@@ -27939,7 +30215,10 @@
"additionalProperties": true,
"description": "Counts of the number of issues in various statuses."
},
- "WorkManagementNavigationInfo": { "type": "object", "properties": { "boardName": { "type": "string" } } },
+ "WorkManagementNavigationInfo": {
+ "type": "object",
+ "properties": { "boardName": { "type": "string" } }
+ },
"FilterDetails": {
"required": ["name"],
"type": "object",
@@ -27950,8 +30229,17 @@
"readOnly": true,
"xml": { "attribute": true }
},
- "self": { "type": "string", "description": "The URL of the filter.", "format": "uri", "readOnly": true },
- "id": { "type": "string", "description": "The unique identifier for the filter.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the filter.",
+ "format": "uri",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier for the filter.",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the filter." },
"description": { "type": "string", "description": "The description of the filter." },
"owner": {
@@ -28010,7 +30298,12 @@
"PageBeanFilterDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -28035,7 +30328,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -28067,7 +30364,9 @@
"ChangeFilterOwner": {
"required": ["accountId"],
"type": "object",
- "properties": { "accountId": { "type": "string", "description": "The account ID of the new owner." } },
+ "properties": {
+ "accountId": { "type": "string", "description": "The account ID of the new owner." }
+ },
"additionalProperties": false,
"description": "The account ID of the new owner.",
"writeOnly": true
@@ -28120,7 +30419,11 @@
"type": "string",
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
},
- "rights": { "type": "integer", "description": "The rights for the share permission.", "format": "int32" },
+ "rights": {
+ "type": "integer",
+ "description": "The rights for the share permission.",
+ "format": "int32"
+ },
"groupId": {
"type": "string",
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products.For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. Cannot be provided with `groupname`."
@@ -28131,7 +30434,12 @@
"PageBeanString": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -28156,7 +30464,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -28220,7 +30532,10 @@
"EntityProperty": {
"type": "object",
"properties": {
- "key": { "type": "string", "description": "The key of the property. Required on create and update." },
+ "key": {
+ "type": "string",
+ "description": "The key of the property. Required on create and update."
+ },
"value": { "description": "The value of the property. Required on create and update." }
},
"additionalProperties": false,
@@ -28353,7 +30668,10 @@
"errors": {
"type": "array",
"description": "Error messages specifying why the webhook creation failed.",
- "items": { "type": "string", "description": "Error messages specifying why the webhook creation failed." }
+ "items": {
+ "type": "string",
+ "description": "Error messages specifying why the webhook creation failed."
+ }
}
},
"additionalProperties": false,
@@ -28362,7 +30680,12 @@
"PageBeanWebhook": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -28387,7 +30710,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -28457,7 +30784,11 @@
"webhookIds": {
"type": "array",
"description": "A list of webhook IDs.",
- "items": { "type": "integer", "description": "A list of webhook IDs.", "format": "int64" }
+ "items": {
+ "type": "integer",
+ "description": "A list of webhook IDs.",
+ "format": "int64"
+ }
}
},
"additionalProperties": false,
@@ -28481,8 +30812,14 @@
"type": "object",
"properties": {
"name": { "type": "string", "description": "The name of the Jira health check item." },
- "description": { "type": "string", "description": "The description of the Jira health check item." },
- "passed": { "type": "boolean", "description": "Whether the Jira health check item passed or failed." }
+ "description": {
+ "type": "string",
+ "description": "The description of the Jira health check item."
+ },
+ "passed": {
+ "type": "boolean",
+ "description": "Whether the Jira health check item passed or failed."
+ }
},
"additionalProperties": false,
"description": "Jira instance health check results. Deprecated and no longer returned."
@@ -28516,7 +30853,10 @@
"description": "The time in Jira when this request was responded to.",
"format": "date-time"
},
- "scmInfo": { "type": "string", "description": "The unique identifier of the Jira version." },
+ "scmInfo": {
+ "type": "string",
+ "description": "The unique identifier of the Jira version."
+ },
"serverTitle": { "type": "string", "description": "The name of the Jira instance." },
"healthChecks": {
"type": "array",
@@ -28559,7 +30899,12 @@
"IssueEvent": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the event.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the event.",
+ "format": "int64",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the event.", "readOnly": true }
},
"additionalProperties": false,
@@ -28643,16 +30988,25 @@
"ApplicationProperty": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the application property. The ID and key are the same." },
+ "id": {
+ "type": "string",
+ "description": "The ID of the application property. The ID and key are the same."
+ },
"key": {
"type": "string",
"description": "The key of the application property. The ID and key are the same."
},
"value": { "type": "string", "description": "The new value." },
"name": { "type": "string", "description": "The name of the application property." },
- "desc": { "type": "string", "description": "The description of the application property." },
+ "desc": {
+ "type": "string",
+ "description": "The description of the application property."
+ },
"type": { "type": "string", "description": "The data type of the application property." },
- "defaultValue": { "type": "string", "description": "The default value of the application property." },
+ "defaultValue": {
+ "type": "string",
+ "description": "The default value of the application property."
+ },
"example": { "type": "string" },
"allowedValues": {
"type": "array",
@@ -28675,10 +31029,26 @@
"AssociatedItemBean": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the associated record.", "readOnly": true },
- "name": { "type": "string", "description": "The name of the associated record.", "readOnly": true },
- "typeName": { "type": "string", "description": "The type of the associated record.", "readOnly": true },
- "parentId": { "type": "string", "description": "The ID of the associated parent record.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the associated record.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the associated record.",
+ "readOnly": true
+ },
+ "typeName": {
+ "type": "string",
+ "description": "The type of the associated record.",
+ "readOnly": true
+ },
+ "parentId": {
+ "type": "string",
+ "description": "The ID of the associated parent record.",
+ "readOnly": true
+ },
"parentName": {
"type": "string",
"description": "The name of the associated parent record.",
@@ -28697,7 +31067,11 @@
"format": "int64",
"readOnly": true
},
- "summary": { "type": "string", "description": "The summary of the audit record.", "readOnly": true },
+ "summary": {
+ "type": "string",
+ "description": "The summary of the audit record.",
+ "readOnly": true
+ },
"remoteAddress": {
"type": "string",
"description": "The URL of the computer where the creation of the audit record was initiated.",
@@ -28724,7 +31098,11 @@
"description": "The event the audit record originated from.",
"readOnly": true
},
- "description": { "type": "string", "description": "The description of the audit record.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the audit record.",
+ "readOnly": true
+ },
"objectItem": { "$ref": "#/components/schemas/AssociatedItemBean" },
"changedValues": {
"type": "array",
@@ -28776,13 +31154,21 @@
"ChangedValueBean": {
"type": "object",
"properties": {
- "fieldName": { "type": "string", "description": "The name of the field changed.", "readOnly": true },
+ "fieldName": {
+ "type": "string",
+ "description": "The name of the field changed.",
+ "readOnly": true
+ },
"changedFrom": {
"type": "string",
"description": "The value of the field before the change.",
"readOnly": true
},
- "changedTo": { "type": "string", "description": "The value of the field after the change.", "readOnly": true }
+ "changedTo": {
+ "type": "string",
+ "description": "The value of the field after the change.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Details of names changed in the record event."
@@ -28791,7 +31177,10 @@
"required": ["key"],
"type": "object",
"properties": {
- "key": { "type": "string", "description": "The key for the time tracking provider. For example, *JIRA*." },
+ "key": {
+ "type": "string",
+ "description": "The key for the time tracking provider. For example, *JIRA*."
+ },
"name": {
"type": "string",
"description": "The name of the time tracking provider. For example, *JIRA provided time tracking*."
@@ -28875,8 +31264,14 @@
"format": "uri",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the permission scheme. Must be unique." },
- "description": { "type": "string", "description": "A description for the permission scheme." },
+ "name": {
+ "type": "string",
+ "description": "The name of the permission scheme. Must be unique."
+ },
+ "description": {
+ "type": "string",
+ "description": "A description for the permission scheme."
+ },
"scope": {
"description": "The scope of the permission scheme.",
"allOf": [{ "$ref": "#/components/schemas/Scope" }]
@@ -28924,7 +31319,12 @@
"PageBeanWorkflowScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -28949,7 +31349,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -28973,7 +31377,10 @@
"type": "string",
"description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme."
},
- "description": { "type": "string", "description": "The description of the workflow scheme." },
+ "description": {
+ "type": "string",
+ "description": "The description of the workflow scheme."
+ },
"defaultWorkflow": {
"type": "string",
"description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*."
@@ -29068,7 +31475,10 @@
"required": ["workflow"],
"type": "object",
"properties": {
- "workflow": { "type": "string", "description": "The name of the workflow to set as the default workflow." },
+ "workflow": {
+ "type": "string",
+ "description": "The name of the workflow to set as the default workflow."
+ },
"updateDraftIfNeeded": {
"type": "boolean",
"description": "Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."
@@ -29102,7 +31512,16 @@
"description": "Details about the mapping from a status to a new status for an issue type."
},
"TaskProgressBeanObject": {
- "required": ["elapsedRuntime", "id", "lastUpdate", "progress", "self", "status", "submitted", "submittedBy"],
+ "required": [
+ "elapsedRuntime",
+ "id",
+ "lastUpdate",
+ "progress",
+ "self",
+ "status",
+ "submitted",
+ "submittedBy"
+ ],
"type": "object",
"properties": {
"self": { "type": "string", "description": "The URL of the task.", "format": "uri" },
@@ -29111,9 +31530,20 @@
"status": {
"type": "string",
"description": "The status of the task.",
- "enum": ["ENQUEUED", "RUNNING", "COMPLETE", "FAILED", "CANCEL_REQUESTED", "CANCELLED", "DEAD"]
+ "enum": [
+ "ENQUEUED",
+ "RUNNING",
+ "COMPLETE",
+ "FAILED",
+ "CANCEL_REQUESTED",
+ "CANCELLED",
+ "DEAD"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "Information about the progress of the task."
},
- "message": { "type": "string", "description": "Information about the progress of the task." },
"result": { "description": "The result of the task execution." },
"submittedBy": {
"type": "integer",
@@ -29200,8 +31630,16 @@
"DeprecatedWorkflow": {
"type": "object",
"properties": {
- "name": { "type": "string", "description": "The name of the workflow.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the workflow.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the workflow.",
+ "readOnly": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the workflow.",
+ "readOnly": true
+ },
"lastModifiedDate": {
"type": "string",
"description": "The datetime the workflow was last modified.",
@@ -29236,7 +31674,11 @@
"CreateWorkflowCondition": {
"type": "object",
"properties": {
- "operator": { "type": "string", "description": "The compound condition operator.", "enum": ["AND", "OR"] },
+ "operator": {
+ "type": "string",
+ "description": "The compound condition operator.",
+ "enum": ["AND", "OR"]
+ },
"conditions": {
"type": "array",
"description": "The list of workflow conditions.",
@@ -29245,7 +31687,9 @@
"type": { "type": "string", "description": "The type of the transition rule." },
"configuration": {
"type": "object",
- "additionalProperties": { "description": "EXPERIMENTAL. The configuration of the transition rule." },
+ "additionalProperties": {
+ "description": "EXPERIMENTAL. The configuration of the transition rule."
+ },
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
},
@@ -29343,7 +31787,9 @@
"type": { "type": "string", "description": "The type of the transition rule." },
"configuration": {
"type": "object",
- "additionalProperties": { "description": "EXPERIMENTAL. The configuration of the transition rule." },
+ "additionalProperties": {
+ "description": "EXPERIMENTAL. The configuration of the transition rule."
+ },
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
},
@@ -29400,7 +31846,11 @@
"readOnly": true
},
"value": { "type": "string", "description": "The value of the transition property." },
- "id": { "type": "string", "description": "The ID of the transition property.", "readOnly": true }
+ "id": {
+ "type": "string",
+ "description": "The ID of the transition property.",
+ "readOnly": true
+ }
},
"additionalProperties": true,
"description": "Details about the server Jira is running on."
@@ -29408,7 +31858,12 @@
"PageBeanWorkflow": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -29433,7 +31888,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -29464,7 +31923,10 @@
"from": {
"type": "array",
"description": "The statuses the transition can start from.",
- "items": { "type": "string", "description": "The statuses the transition can start from." }
+ "items": {
+ "type": "string",
+ "description": "The statuses the transition can start from."
+ }
},
"to": { "type": "string", "description": "The status the transition goes to." },
"type": {
@@ -29509,7 +31971,10 @@
"description": "The statuses of the workflow.",
"items": { "$ref": "#/components/schemas/WorkflowStatus" }
},
- "isDefault": { "type": "boolean", "description": "Whether this is the default workflow." },
+ "isDefault": {
+ "type": "boolean",
+ "description": "Whether this is the default workflow."
+ },
"schemes": {
"type": "array",
"description": "The workflow schemes the workflow is assigned to.",
@@ -29520,10 +31985,21 @@
"description": "The projects the workflow is assigned to, through workflow schemes.",
"items": { "$ref": "#/components/schemas/ProjectDetails" }
},
- "hasDraftWorkflow": { "type": "boolean", "description": "Whether the workflow has a draft version." },
+ "hasDraftWorkflow": {
+ "type": "boolean",
+ "description": "Whether the workflow has a draft version."
+ },
"operations": { "$ref": "#/components/schemas/WorkflowOperations" },
- "created": { "type": "string", "description": "The creation date of the workflow.", "format": "date-time" },
- "updated": { "type": "string", "description": "The last edited date of the workflow.", "format": "date-time" }
+ "created": {
+ "type": "string",
+ "description": "The creation date of the workflow.",
+ "format": "date-time"
+ },
+ "updated": {
+ "type": "string",
+ "description": "The last edited date of the workflow.",
+ "format": "date-time"
+ }
},
"additionalProperties": false,
"description": "Details about a workflow."
@@ -29532,7 +32008,11 @@
"required": ["conditions", "nodeType", "operator"],
"type": "object",
"properties": {
- "operator": { "type": "string", "description": "The compound condition operator.", "enum": ["AND", "OR"] },
+ "operator": {
+ "type": "string",
+ "description": "The compound condition operator.",
+ "enum": ["AND", "OR"]
+ },
"conditions": {
"type": "array",
"description": "The list of workflow conditions.",
@@ -29631,7 +32111,9 @@
"type": "object",
"properties": {
"type": { "type": "string", "description": "The type of the transition rule." },
- "configuration": { "description": "EXPERIMENTAL. The configuration of the transition rule." }
+ "configuration": {
+ "description": "EXPERIMENTAL. The configuration of the transition rule."
+ }
},
"additionalProperties": false,
"description": "A workflow transition rule."
@@ -29647,7 +32129,10 @@
"readOnly": true
},
"configuration": { "$ref": "#/components/schemas/RuleConfiguration" },
- "transition": { "readOnly": true, "allOf": [{ "$ref": "#/components/schemas/WorkflowTransition" }] }
+ "transition": {
+ "readOnly": true,
+ "allOf": [{ "$ref": "#/components/schemas/WorkflowTransition" }]
+ }
},
"additionalProperties": false,
"description": "A workflow transition rule."
@@ -29655,7 +32140,12 @@
"PageBeanWorkflowTransitionRules": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -29680,7 +32170,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -29718,7 +32212,10 @@
"type": "object",
"properties": {
"name": { "type": "string", "description": "The name of the workflow." },
- "draft": { "type": "boolean", "description": "Whether the workflow is in the draft state." }
+ "draft": {
+ "type": "boolean",
+ "description": "Whether the workflow is in the draft state."
+ }
},
"additionalProperties": false,
"description": "Properties that identify a workflow."
@@ -29792,7 +32289,10 @@
"uniqueItems": true,
"type": "array",
"description": "The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.",
- "items": { "type": "string", "description": "An error specifying why the workflow update failed." }
+ "items": {
+ "type": "string",
+ "description": "An error specifying why the workflow update failed."
+ }
}
},
"additionalProperties": false,
@@ -29904,7 +32404,11 @@
"description": "The index of the first item returned on the page.",
"format": "int64"
},
- "total": { "type": "integer", "description": "Number of items that satisfy the search.", "format": "int64" },
+ "total": {
+ "type": "integer",
+ "description": "Number of items that satisfy the search.",
+ "format": "int64"
+ },
"isLast": { "type": "boolean", "description": "Whether this is the last page." },
"maxResults": {
"type": "integer",
@@ -29917,7 +32421,10 @@
"items": { "$ref": "#/components/schemas/JiraStatus" }
},
"self": { "type": "string", "description": "The URL of this page." },
- "nextPage": { "type": "string", "description": "The URL of the next page of results, if any." }
+ "nextPage": {
+ "type": "string",
+ "description": "The URL of the next page of results, if any."
+ }
},
"additionalProperties": false
},
@@ -30057,7 +32564,11 @@
"VersionUsageInCustomField": {
"type": "object",
"properties": {
- "fieldName": { "type": "string", "description": "The name of the custom field.", "readOnly": true },
+ "fieldName": {
+ "type": "string",
+ "description": "The name of the custom field.",
+ "readOnly": true
+ },
"customFieldId": {
"type": "integer",
"description": "The ID of the custom field.",
@@ -30089,7 +32600,12 @@
"format": "int64",
"readOnly": true
},
- "issuesCount": { "type": "integer", "description": "Count of issues.", "format": "int64", "readOnly": true }
+ "issuesCount": {
+ "type": "integer",
+ "description": "Count of issues.",
+ "format": "int64",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Count of a version's unresolved issues.",
@@ -30152,7 +32668,11 @@
"type": "string",
"description": "The display name of the user. Depending on the user’s privacy setting, this may be returned as null."
},
- "avatarUrl": { "type": "string", "description": "The avatar URL of the user.", "format": "uri" }
+ "avatarUrl": {
+ "type": "string",
+ "description": "The avatar URL of the user.",
+ "format": "uri"
+ }
},
"additionalProperties": false,
"description": "A user found in a search."
@@ -30208,7 +32728,11 @@
"description": "Whether the avatar is used in Jira. For example, shown as a project's avatar.",
"readOnly": true
},
- "isDeletable": { "type": "boolean", "description": "Whether the avatar can be deleted.", "readOnly": true },
+ "isDeletable": {
+ "type": "boolean",
+ "description": "Whether the avatar can be deleted.",
+ "readOnly": true
+ },
"fileName": {
"type": "string",
"description": "The file name of the avatar icon. Returned for system avatars.",
@@ -30247,7 +32771,12 @@
"required": ["name"],
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the screen tab.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the screen tab.",
+ "format": "int64",
+ "readOnly": true
+ },
"name": {
"type": "string",
"description": "The name of the screen tab. The maximum length is 255 characters."
@@ -30259,7 +32788,12 @@
"PageBeanScreen": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -30284,7 +32818,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -30298,10 +32836,22 @@
"Screen": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the screen.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the screen.",
+ "format": "int64",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the screen.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the screen.", "readOnly": true },
- "scope": { "description": "The scope of the screen.", "allOf": [{ "$ref": "#/components/schemas/Scope" }] }
+ "description": {
+ "type": "string",
+ "description": "The description of the screen.",
+ "readOnly": true
+ },
+ "scope": {
+ "description": "The scope of the screen.",
+ "allOf": [{ "$ref": "#/components/schemas/Scope" }]
+ }
},
"additionalProperties": false,
"description": "A screen."
@@ -30309,7 +32859,11 @@
"ScreenableField": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the screen tab field.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the screen tab field.",
+ "readOnly": true
+ },
"name": {
"type": "string",
"description": "The name of the screen tab field. Required on create and update. The maximum length is 255 characters."
@@ -30337,7 +32891,9 @@
"AddFieldBean": {
"required": ["fieldId"],
"type": "object",
- "properties": { "fieldId": { "type": "string", "description": "The ID of the field to add." } },
+ "properties": {
+ "fieldId": { "type": "string", "description": "The ID of the field to add." }
+ },
"additionalProperties": false
},
"ScreenDetails": {
@@ -30378,9 +32934,16 @@
"Resolution": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the issue resolution.", "format": "uri" },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue resolution.",
+ "format": "uri"
+ },
"id": { "type": "string", "description": "The ID of the issue resolution." },
- "description": { "type": "string", "description": "The description of the issue resolution." },
+ "description": {
+ "type": "string",
+ "description": "The description of the issue resolution."
+ },
"name": { "type": "string", "description": "The name of the issue resolution." }
},
"additionalProperties": false,
@@ -30513,7 +33076,11 @@
"format": "int64",
"readOnly": true
},
- "key": { "type": "string", "description": "The key of the created project.", "readOnly": true }
+ "key": {
+ "type": "string",
+ "description": "The key of the created project.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Identifiers for a project."
@@ -30577,7 +33144,12 @@
"PageBeanVersion": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -30602,7 +33174,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -30622,9 +33198,21 @@
"format": "int64",
"readOnly": true
},
- "name": { "type": "string", "description": "The name for the component.", "readOnly": true },
- "id": { "type": "string", "description": "The unique identifier for the component.", "readOnly": true },
- "description": { "type": "string", "description": "The description for the component.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name for the component.",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier for the component.",
+ "readOnly": true
+ },
+ "description": {
+ "type": "string",
+ "description": "The description for the component.",
+ "readOnly": true
+ },
"self": {
"type": "string",
"description": "The URL for this count of the issues contained in the component.",
@@ -30650,7 +33238,12 @@
"description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component.",
"allOf": [{ "$ref": "#/components/schemas/User" }]
},
- "projectId": { "type": "integer", "description": "Not used.", "format": "int64", "readOnly": true },
+ "projectId": {
+ "type": "integer",
+ "description": "Not used.",
+ "format": "int64",
+ "readOnly": true
+ },
"realAssignee": {
"description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee.",
"allOf": [{ "$ref": "#/components/schemas/User" }]
@@ -30673,7 +33266,12 @@
"PageBeanComponentWithIssueCount": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -30698,7 +33296,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -30713,7 +33315,12 @@
"PageBeanProject": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -30738,7 +33345,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -30772,9 +33383,17 @@
"required": ["id", "name", "self", "statuses", "subtask"],
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the issue type's status details.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue type's status details.",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the issue type.", "readOnly": true },
- "name": { "type": "string", "description": "The name of the issue type.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue type.",
+ "readOnly": true
+ },
"subtask": {
"type": "boolean",
"description": "Whether this issue type represents subtasks.",
@@ -30793,14 +33412,26 @@
"SecurityLevel": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the issue level security item.", "readOnly": true },
- "id": { "type": "string", "description": "The ID of the issue level security item.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue level security item.",
+ "readOnly": true
+ },
+ "id": {
+ "type": "string",
+ "description": "The ID of the issue level security item.",
+ "readOnly": true
+ },
"description": {
"type": "string",
"description": "The description of the issue level security item.",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the issue level security item.", "readOnly": true }
+ "name": {
+ "type": "string",
+ "description": "The name of the issue level security item.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Details of an issue level security item."
@@ -30808,14 +33439,22 @@
"SecurityScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the issue security scheme.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue security scheme.",
+ "readOnly": true
+ },
"id": {
"type": "integer",
"description": "The ID of the issue security scheme.",
"format": "int64",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the issue security scheme.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue security scheme.",
+ "readOnly": true
+ },
"description": {
"type": "string",
"description": "The description of the issue security scheme.",
@@ -30847,22 +33486,38 @@
"ProjectFeature": {
"type": "object",
"properties": {
- "projectId": { "type": "integer", "description": "The ID of the project.", "format": "int64" },
+ "projectId": {
+ "type": "integer",
+ "description": "The ID of the project.",
+ "format": "int64"
+ },
"state": {
"type": "string",
"description": "The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values",
"enum": ["ENABLED", "DISABLED", "COMING_SOON"]
},
- "toggleLocked": { "type": "boolean", "description": "Whether the state of the feature can be updated." },
+ "toggleLocked": {
+ "type": "boolean",
+ "description": "Whether the state of the feature can be updated."
+ },
"feature": { "type": "string", "description": "The key of the feature." },
"prerequisites": {
"type": "array",
"description": "List of keys of the features required to enable the feature.",
"items": { "type": "string" }
},
- "localisedName": { "type": "string", "description": "Localized display name for the feature." },
- "localisedDescription": { "type": "string", "description": "Localized display description for the feature." },
- "imageUri": { "type": "string", "description": "URI for the image representing the feature." }
+ "localisedName": {
+ "type": "string",
+ "description": "Localized display name for the feature."
+ },
+ "localisedDescription": {
+ "type": "string",
+ "description": "Localized display description for the feature."
+ },
+ "imageUri": {
+ "type": "string",
+ "description": "URI for the image representing the feature."
+ }
},
"additionalProperties": false,
"description": "Details of a project feature."
@@ -30883,9 +33538,18 @@
"type": "object",
"properties": {
"self": { "type": "string", "description": "The URL of the issue priority." },
- "statusColor": { "type": "string", "description": "The color used to indicate the issue priority." },
- "description": { "type": "string", "description": "The description of the issue priority." },
- "iconUrl": { "type": "string", "description": "The URL of the icon for the issue priority." },
+ "statusColor": {
+ "type": "string",
+ "description": "The color used to indicate the issue priority."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the issue priority."
+ },
+ "iconUrl": {
+ "type": "string",
+ "description": "The URL of the icon for the issue priority."
+ },
"name": { "type": "string", "description": "The name of the issue priority." },
"id": { "type": "string", "description": "The ID of the issue priority." },
"isDefault": { "type": "boolean", "description": "Whether this priority is the default." }
@@ -30939,7 +33603,13 @@
"PriorityId": {
"required": ["id"],
"type": "object",
- "properties": { "id": { "type": "string", "description": "The ID of the issue priority.", "readOnly": true } },
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "The ID of the issue priority.",
+ "readOnly": true
+ }
+ },
"additionalProperties": true,
"description": "The ID of an issue priority."
},
@@ -30988,7 +33658,12 @@
"PageBeanPriority": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -31013,7 +33688,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -31037,7 +33716,11 @@
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
},
- "renderedBody": { "type": "string", "description": "The rendered version of the comment.", "readOnly": true },
+ "renderedBody": {
+ "type": "string",
+ "description": "The rendered version of the comment.",
+ "readOnly": true
+ },
"updateAuthor": {
"description": "The ID of the user who updated the comment last.",
"readOnly": true,
@@ -31162,9 +33845,20 @@
"LinkedIssue": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of an issue. Required if `key` isn't provided." },
- "key": { "type": "string", "description": "The key of an issue. Required if `id` isn't provided." },
- "self": { "type": "string", "description": "The URL of the issue.", "format": "uri", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of an issue. Required if `key` isn't provided."
+ },
+ "key": {
+ "type": "string",
+ "description": "The key of an issue. Required if `id` isn't provided."
+ },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue.",
+ "format": "uri",
+ "readOnly": true
+ },
"fields": {
"description": "The fields associated with the issue.",
"readOnly": true,
@@ -31249,7 +33943,12 @@
"type": "object",
"properties": {
"id": { "type": "string", "description": "The ID of the issue link.", "readOnly": true },
- "self": { "type": "string", "description": "The URL of the issue link.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the issue link.",
+ "format": "uri",
+ "readOnly": true
+ },
"type": {
"description": "The type of link between the issues.",
"allOf": [{ "$ref": "#/components/schemas/IssueLinkType" }]
@@ -31350,8 +34049,16 @@
"description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided.",
"format": "int64"
},
- "id": { "type": "string", "description": "The ID of the worklog record.", "readOnly": true },
- "issueId": { "type": "string", "description": "The ID of the issue this worklog is for.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the worklog record.",
+ "readOnly": true
+ },
+ "issueId": {
+ "type": "string",
+ "description": "The ID of the issue this worklog is for.",
+ "readOnly": true
+ },
"properties": {
"type": "array",
"description": "Details of properties for the worklog. Optional when creating or updating a worklog.",
@@ -31392,7 +34099,11 @@
"description": "The unique name for the issue type. The maximum length is 60 characters."
},
"description": { "type": "string", "description": "The description of the issue type." },
- "avatarId": { "type": "integer", "description": "The ID of an issue type avatar.", "format": "int64" }
+ "avatarId": {
+ "type": "integer",
+ "description": "The ID of an issue type avatar.",
+ "format": "int64"
+ }
},
"additionalProperties": false
},
@@ -31413,7 +34124,11 @@
"required": ["holder", "id", "issueSecurityLevelId"],
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the issue security level member.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the issue security level member.",
+ "format": "int64"
+ },
"issueSecurityLevelId": {
"type": "integer",
"description": "The ID of the issue security level.",
@@ -31430,7 +34145,12 @@
"PageBeanIssueSecurityLevelMember": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -31455,7 +34175,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -31534,10 +34258,23 @@
"SuggestedIssue": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the issue.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the issue.",
+ "format": "int64",
+ "readOnly": true
+ },
"key": { "type": "string", "description": "The key of the issue.", "readOnly": true },
- "keyHtml": { "type": "string", "description": "The key of the issue in HTML format.", "readOnly": true },
- "img": { "type": "string", "description": "The URL of the issue type's avatar.", "readOnly": true },
+ "keyHtml": {
+ "type": "string",
+ "description": "The key of the issue in HTML format.",
+ "readOnly": true
+ },
+ "img": {
+ "type": "string",
+ "description": "The URL of the issue type's avatar.",
+ "readOnly": true
+ },
"summary": {
"type": "string",
"description": "The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags.",
@@ -31633,7 +34370,11 @@
"required": ["issueIds"],
"type": "object",
"properties": {
- "issueIds": { "type": "array", "description": "The list of issue IDs.", "items": { "type": "string" } }
+ "issueIds": {
+ "type": "array",
+ "description": "The list of issue IDs.",
+ "items": { "type": "string" }
+ }
},
"additionalProperties": false,
"description": "A list of issue IDs."
@@ -31654,7 +34395,11 @@
"Watchers": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of these issue watcher details.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of these issue watcher details.",
+ "readOnly": true
+ },
"isWatching": {
"type": "boolean",
"description": "Whether the calling user is watching this issue.",
@@ -31680,9 +34425,21 @@
"CreatedIssue": {
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the created issue or subtask.", "readOnly": true },
- "key": { "type": "string", "description": "The key of the created issue or subtask.", "readOnly": true },
- "self": { "type": "string", "description": "The URL of the created issue or subtask.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the created issue or subtask.",
+ "readOnly": true
+ },
+ "key": {
+ "type": "string",
+ "description": "The key of the created issue or subtask.",
+ "readOnly": true
+ },
+ "self": {
+ "type": "string",
+ "description": "The URL of the created issue or subtask.",
+ "readOnly": true
+ },
"transition": {
"description": "The response code and messages related to any requested transition.",
"readOnly": true,
@@ -31703,7 +34460,10 @@
"IssuesUpdateBean": {
"type": "object",
"properties": {
- "issueUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/IssueUpdateDetails" } }
+ "issueUpdates": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueUpdateDetails" }
+ }
},
"additionalProperties": true
},
@@ -31757,11 +34517,27 @@
"IssueTypeIssueCreateMetadata": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of these issue type details.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of these issue type details.",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the issue type.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the issue type.", "readOnly": true },
- "iconUrl": { "type": "string", "description": "The URL of the issue type's avatar.", "readOnly": true },
- "name": { "type": "string", "description": "The name of the issue type.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the issue type.",
+ "readOnly": true
+ },
+ "iconUrl": {
+ "type": "string",
+ "description": "The URL of the issue type's avatar.",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue type.",
+ "readOnly": true
+ },
"subtask": {
"type": "boolean",
"description": "Whether this issue type is used to create subtasks.",
@@ -31853,8 +34629,14 @@
"type": "object",
"properties": {
"url16x16": { "type": "string", "description": "The URL of a 16x16 pixel icon." },
- "title": { "type": "string", "description": "The title of the icon, for use as a tooltip on the icon." },
- "link": { "type": "string", "description": "The URL of the tooltip, used only for a status icon." }
+ "title": {
+ "type": "string",
+ "description": "The title of the icon, for use as a tooltip on the icon."
+ },
+ "link": {
+ "type": "string",
+ "description": "The URL of the tooltip, used only for a status icon."
+ }
},
"additionalProperties": false,
"description": "An icon.",
@@ -31896,7 +34678,10 @@
"description": "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.",
"allOf": [{ "$ref": "#/components/schemas/Icon" }]
},
- "status": { "description": "The status of the item.", "allOf": [{ "$ref": "#/components/schemas/Status" }] }
+ "status": {
+ "description": "The status of the item.",
+ "allOf": [{ "$ref": "#/components/schemas/Status" }]
+ }
},
"additionalProperties": true,
"description": "The linked item."
@@ -31919,7 +34704,10 @@
"Icon": {
"type": "object",
"properties": {
- "url16x16": { "type": "string", "description": "The URL of an icon that displays at 16x16 pixel in Jira." },
+ "url16x16": {
+ "type": "string",
+ "description": "The URL of an icon that displays at 16x16 pixel in Jira."
+ },
"title": {
"type": "string",
"description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
@@ -31987,7 +34775,10 @@
"type": "string",
"description": "The plain text body of the email notification for the issue."
},
- "htmlBody": { "type": "string", "description": "The HTML body of the email notification for the issue." },
+ "htmlBody": {
+ "type": "string",
+ "description": "The HTML body of the email notification for the issue."
+ },
"to": {
"description": "The recipients of the email notification for the issue.",
"allOf": [{ "$ref": "#/components/schemas/NotificationRecipients" }]
@@ -32147,7 +34938,12 @@
"PageBeanComment": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32172,7 +34968,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32186,7 +34986,12 @@
"PageBeanChangelog": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32211,7 +35016,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32239,9 +35048,17 @@
"Attachment": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the attachment details response.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the attachment details response.",
+ "readOnly": true
+ },
"id": { "type": "string", "description": "The ID of the attachment.", "readOnly": true },
- "filename": { "type": "string", "description": "The file name of the attachment.", "readOnly": true },
+ "filename": {
+ "type": "string",
+ "description": "The file name of the attachment.",
+ "readOnly": true
+ },
"author": {
"description": "Details of the user who added the attachment.",
"readOnly": true,
@@ -32259,8 +35076,16 @@
"format": "int64",
"readOnly": true
},
- "mimeType": { "type": "string", "description": "The MIME type of the attachment.", "readOnly": true },
- "content": { "type": "string", "description": "The content of the attachment.", "readOnly": true },
+ "mimeType": {
+ "type": "string",
+ "description": "The MIME type of the attachment.",
+ "readOnly": true
+ },
+ "content": {
+ "type": "string",
+ "description": "The content of the attachment.",
+ "readOnly": true
+ },
"thumbnail": {
"type": "string",
"description": "The URL of a thumbnail representing the attachment.",
@@ -32343,7 +35168,12 @@
"PageBeanUserDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32368,7 +35198,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32478,14 +35312,20 @@
"type": "boolean",
"description": "Whether the field can be used as a column on the issue navigator."
},
- "searchable": { "type": "boolean", "description": "Whether the content of the field can be searched." },
+ "searchable": {
+ "type": "boolean",
+ "description": "Whether the content of the field can be searched."
+ },
"clauseNames": {
"uniqueItems": true,
"type": "array",
"description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).",
"items": { "type": "string" }
},
- "scope": { "description": "The scope of the field.", "allOf": [{ "$ref": "#/components/schemas/Scope" }] },
+ "scope": {
+ "description": "The scope of the field.",
+ "allOf": [{ "$ref": "#/components/schemas/Scope" }]
+ },
"schema": {
"description": "The data schema for the field.",
"allOf": [{ "$ref": "#/components/schemas/JsonTypeBean" }]
@@ -32571,7 +35411,12 @@
"PageBeanScreenWithTab": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32596,7 +35441,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32610,10 +35459,22 @@
"ScreenWithTab": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the screen.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the screen.",
+ "format": "int64",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the screen.", "readOnly": true },
- "description": { "type": "string", "description": "The description of the screen.", "readOnly": true },
- "scope": { "description": "The scope of the screen.", "allOf": [{ "$ref": "#/components/schemas/Scope" }] },
+ "description": {
+ "type": "string",
+ "description": "The description of the screen.",
+ "readOnly": true
+ },
+ "scope": {
+ "description": "The scope of the screen.",
+ "allOf": [{ "$ref": "#/components/schemas/Scope" }]
+ },
"tab": {
"description": "The tab for the screen.",
"allOf": [{ "$ref": "#/components/schemas/ScreenableTab" }]
@@ -32625,9 +35486,17 @@
"Context": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the context.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the context.",
+ "format": "int64",
+ "readOnly": true
+ },
"name": { "type": "string", "description": "The name of the context.", "readOnly": true },
- "scope": { "description": "The scope of the context.", "allOf": [{ "$ref": "#/components/schemas/Scope" }] }
+ "scope": {
+ "description": "The scope of the context.",
+ "allOf": [{ "$ref": "#/components/schemas/Scope" }]
+ }
},
"additionalProperties": false,
"description": "A context."
@@ -32635,7 +35504,12 @@
"PageBeanContext": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32660,7 +35534,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32689,7 +35567,12 @@
"PageBeanCustomFieldContextOption": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32714,7 +35597,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32864,12 +35751,18 @@
"properties": {
"id": { "type": "string", "description": "The ID of the issue type scheme." },
"name": { "type": "string", "description": "The name of the issue type scheme." },
- "description": { "type": "string", "description": "The description of the issue type scheme." },
+ "description": {
+ "type": "string",
+ "description": "The description of the issue type scheme."
+ },
"defaultIssueTypeId": {
"type": "string",
"description": "The ID of the default issue type of the issue type scheme."
},
- "isDefault": { "type": "boolean", "description": "Whether the issue type scheme is the default." }
+ "isDefault": {
+ "type": "boolean",
+ "description": "Whether the issue type scheme is the default."
+ }
},
"additionalProperties": false,
"description": "Details of an issue type scheme."
@@ -32877,7 +35770,12 @@
"PageBeanIssueTypeScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32902,7 +35800,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32933,7 +35835,12 @@
"PageBeanIssueTypeSchemeProjects": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -32958,7 +35865,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -32973,7 +35884,10 @@
"required": ["issueTypeId", "issueTypeSchemeId"],
"type": "object",
"properties": {
- "issueTypeSchemeId": { "type": "string", "description": "The ID of the issue type scheme." },
+ "issueTypeSchemeId": {
+ "type": "string",
+ "description": "The ID of the issue type scheme."
+ },
"issueTypeId": { "type": "string", "description": "The ID of the issue type." }
},
"additionalProperties": false,
@@ -32982,7 +35896,12 @@
"PageBeanIssueTypeSchemeMapping": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33007,7 +35926,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33027,7 +35950,11 @@
"description": "The ID of the issue type scheme.",
"writeOnly": true
},
- "projectId": { "type": "string", "description": "The ID of the project.", "writeOnly": true }
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the project.",
+ "writeOnly": true
+ }
},
"additionalProperties": false,
"description": "Details of the association between an issue type scheme and project."
@@ -33065,7 +35992,11 @@
"required": ["issueTypeSchemeId"],
"type": "object",
"properties": {
- "issueTypeSchemeId": { "type": "string", "description": "The ID of the issue type scheme.", "readOnly": true }
+ "issueTypeSchemeId": {
+ "type": "string",
+ "description": "The ID of the issue type scheme.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "The ID of an issue type scheme."
@@ -33228,7 +36159,10 @@
"description": "The unique identifier for the option. This is only unique within the select field's set of options.",
"format": "int64"
},
- "value": { "type": "string", "description": "The option's name, which is displayed in Jira." },
+ "value": {
+ "type": "string",
+ "description": "The option's name, which is displayed in Jira."
+ },
"properties": {
"type": "object",
"additionalProperties": {},
@@ -33281,7 +36215,12 @@
"PageBeanIssueFieldOption": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33306,7 +36245,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33338,7 +36281,10 @@
"required": ["value"],
"type": "object",
"properties": {
- "value": { "type": "string", "description": "The option's name, which is displayed in Jira." },
+ "value": {
+ "type": "string",
+ "description": "The option's name, which is displayed in Jira."
+ },
"properties": {
"type": "object",
"additionalProperties": {},
@@ -33386,7 +36332,16 @@
"additionalProperties": false
},
"TaskProgressBeanRemoveOptionFromIssuesResult": {
- "required": ["elapsedRuntime", "id", "lastUpdate", "progress", "self", "status", "submitted", "submittedBy"],
+ "required": [
+ "elapsedRuntime",
+ "id",
+ "lastUpdate",
+ "progress",
+ "self",
+ "status",
+ "submitted",
+ "submittedBy"
+ ],
"type": "object",
"properties": {
"self": { "type": "string", "description": "The URL of the task.", "format": "uri" },
@@ -33395,9 +36350,20 @@
"status": {
"type": "string",
"description": "The status of the task.",
- "enum": ["ENQUEUED", "RUNNING", "COMPLETE", "FAILED", "CANCEL_REQUESTED", "CANCELLED", "DEAD"]
+ "enum": [
+ "ENQUEUED",
+ "RUNNING",
+ "COMPLETE",
+ "FAILED",
+ "CANCEL_REQUESTED",
+ "CANCELLED",
+ "DEAD"
+ ]
+ },
+ "message": {
+ "type": "string",
+ "description": "Information about the progress of the task."
},
- "message": { "type": "string", "description": "Information about the progress of the task." },
"result": {
"description": "The result of the task execution.",
"allOf": [{ "$ref": "#/components/schemas/RemoveOptionFromIssuesResult" }]
@@ -33451,7 +36417,10 @@
"description": { "type": "string", "description": "The description of the field." },
"key": { "type": "string", "description": "The key of the field." },
"isLocked": { "type": "boolean", "description": "Whether the field is locked." },
- "isUnscreenable": { "type": "boolean", "description": "Whether the field is shown on screen or not." },
+ "isUnscreenable": {
+ "type": "boolean",
+ "description": "Whether the field is shown on screen or not."
+ },
"searcherKey": {
"type": "string",
"description": "The searcher key of the field. Returned for custom fields."
@@ -33491,7 +36460,12 @@
"PageBeanField": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33516,7 +36490,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33532,8 +36510,14 @@
"type": "object",
"properties": {
"id": { "type": "string", "description": "The ID of the field configuration scheme." },
- "name": { "type": "string", "description": "The name of the field configuration scheme." },
- "description": { "type": "string", "description": "The description of the field configuration scheme." }
+ "name": {
+ "type": "string",
+ "description": "The name of the field configuration scheme."
+ },
+ "description": {
+ "type": "string",
+ "description": "The description of the field configuration scheme."
+ }
},
"additionalProperties": false,
"description": "Details of a field configuration scheme."
@@ -33541,7 +36525,12 @@
"PageBeanFieldConfigurationScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33566,7 +36555,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33589,7 +36582,10 @@
"type": "string",
"description": "The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration."
},
- "fieldConfigurationId": { "type": "string", "description": "The ID of the field configuration." }
+ "fieldConfigurationId": {
+ "type": "string",
+ "description": "The ID of the field configuration."
+ }
},
"additionalProperties": false,
"description": "The field configuration for an issue type."
@@ -33597,7 +36593,12 @@
"PageBeanFieldConfigurationIssueTypeItem": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33622,7 +36623,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33675,7 +36680,10 @@
"projectIds": {
"type": "array",
"description": "The IDs of projects using the field configuration scheme.",
- "items": { "type": "string", "description": "The IDs of projects using the field configuration scheme." }
+ "items": {
+ "type": "string",
+ "description": "The IDs of projects using the field configuration scheme."
+ }
}
},
"additionalProperties": false,
@@ -33684,7 +36692,12 @@
"PageBeanFieldConfigurationSchemeProjects": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33709,7 +36722,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33729,7 +36746,11 @@
"description": "The ID of the field configuration scheme. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme.",
"writeOnly": true
},
- "projectId": { "type": "string", "description": "The ID of the project.", "writeOnly": true }
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the project.",
+ "writeOnly": true
+ }
},
"additionalProperties": false,
"description": "Associated field configuration scheme and project."
@@ -33790,7 +36811,12 @@
"PageBeanFieldConfigurationDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33815,7 +36841,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33830,12 +36860,18 @@
"required": ["id"],
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the field within the field configuration." },
+ "id": {
+ "type": "string",
+ "description": "The ID of the field within the field configuration."
+ },
"description": {
"type": "string",
"description": "The description of the field within the field configuration."
},
- "isHidden": { "type": "boolean", "description": "Whether the field is hidden in the field configuration." },
+ "isHidden": {
+ "type": "boolean",
+ "description": "Whether the field is hidden in the field configuration."
+ },
"isRequired": {
"type": "boolean",
"description": "Whether the field is required in the field configuration."
@@ -33851,7 +36887,12 @@
"PageBeanFieldConfigurationItem": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33876,7 +36917,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33891,10 +36936,20 @@
"required": ["description", "id", "name"],
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the field configuration.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the field configuration.",
+ "format": "int64"
+ },
"name": { "type": "string", "description": "The name of the field configuration." },
- "description": { "type": "string", "description": "The description of the field configuration." },
- "isDefault": { "type": "boolean", "description": "Whether the field configuration is the default." }
+ "description": {
+ "type": "string",
+ "description": "The description of the field configuration."
+ },
+ "isDefault": {
+ "type": "boolean",
+ "description": "Whether the field configuration is the default."
+ }
},
"additionalProperties": false,
"description": "Details of a field configuration."
@@ -33922,7 +36977,11 @@
"format": "uri",
"readOnly": true
},
- "value": { "type": "string", "description": "The value of the custom field option.", "readOnly": true }
+ "value": {
+ "type": "string",
+ "description": "The value of the custom field option.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Details of a custom option for a field.",
@@ -33932,9 +36991,21 @@
"required": ["contextId"],
"type": "object",
"properties": {
- "contextId": { "type": "string", "description": "The ID of the context.", "readOnly": true },
- "projectId": { "type": "string", "description": "The ID of the project.", "readOnly": true },
- "isGlobalContext": { "type": "boolean", "description": "Whether context is global.", "readOnly": true }
+ "contextId": {
+ "type": "string",
+ "description": "The ID of the context.",
+ "readOnly": true
+ },
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the project.",
+ "readOnly": true
+ },
+ "isGlobalContext": {
+ "type": "boolean",
+ "description": "Whether context is global.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Details of a context to project association."
@@ -33942,7 +37013,12 @@
"PageBeanCustomFieldContextProjectMapping": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -33967,7 +37043,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -33986,7 +37066,10 @@
"name": { "type": "string", "description": "The name of the context." },
"description": { "type": "string", "description": "The description of the context." },
"isGlobalContext": { "type": "boolean", "description": "Whether the context is global." },
- "isAnyIssueType": { "type": "boolean", "description": "Whether the context apply to all issue types." }
+ "isAnyIssueType": {
+ "type": "boolean",
+ "description": "Whether the context apply to all issue types."
+ }
},
"additionalProperties": false,
"description": "The details of a custom field context."
@@ -33994,7 +37077,12 @@
"PageBeanCustomFieldContext": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34019,7 +37107,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34101,7 +37193,10 @@
"properties": {
"contextId": { "type": "string", "description": "The ID of the context." },
"optionId": { "type": "string", "description": "The ID of the default option." },
- "cascadingOptionId": { "type": "string", "description": "The ID of the default cascading option." },
+ "cascadingOptionId": {
+ "type": "string",
+ "description": "The ID of the default cascading option."
+ },
"type": { "type": "string" }
},
"description": "The default value for a cascading select custom field."
@@ -34114,7 +37209,11 @@
"type": "string",
"description": "The default date in ISO format. Ignored if `useCurrent` is true."
},
- "useCurrent": { "type": "boolean", "description": "Whether to use the current date.", "default": false },
+ "useCurrent": {
+ "type": "boolean",
+ "description": "Whether to use the current date.",
+ "default": false
+ },
"type": { "type": "string" }
},
"description": "The default value for a Date custom field."
@@ -34127,7 +37226,11 @@
"type": "string",
"description": "The default date-time in ISO format. Ignored if `useCurrent` is true."
},
- "useCurrent": { "type": "boolean", "description": "Whether to use the current date.", "default": false },
+ "useCurrent": {
+ "type": "boolean",
+ "description": "Whether to use the current date.",
+ "default": false
+ },
"type": { "type": "string" }
},
"description": "The default value for a date time custom field."
@@ -34136,7 +37239,11 @@
"required": ["number", "type"],
"type": "object",
"properties": {
- "number": { "type": "number", "description": "The default floating-point number.", "format": "double" },
+ "number": {
+ "type": "number",
+ "description": "The default floating-point number.",
+ "format": "double"
+ },
"type": { "type": "string" }
},
"description": "Default value for a float (number) custom field."
@@ -34148,7 +37255,11 @@
"type": "string",
"description": "The default date-time in ISO format. Ignored if `useCurrent` is true."
},
- "useCurrent": { "type": "boolean", "description": "Whether to use the current date.", "default": false }
+ "useCurrent": {
+ "type": "boolean",
+ "description": "Whether to use the current date.",
+ "default": false
+ }
},
"description": "The default value for a Forge date time custom field."
},
@@ -34208,7 +37319,11 @@
"required": ["number"],
"type": "object",
"properties": {
- "number": { "type": "number", "description": "The default floating-point number.", "format": "double" }
+ "number": {
+ "type": "number",
+ "description": "The default floating-point number.",
+ "format": "double"
+ }
},
"description": "Default value for a Forge number custom field."
},
@@ -34224,7 +37339,10 @@
"CustomFieldContextDefaultValueForgeStringField": {
"type": "object",
"properties": {
- "text": { "type": "string", "description": "The default text. The maximum length is 254 characters." }
+ "text": {
+ "type": "string",
+ "description": "The default text. The maximum length is 254 characters."
+ }
},
"description": "The default text for a Forge string custom field."
},
@@ -34326,7 +37444,10 @@
"required": ["type"],
"type": "object",
"properties": {
- "text": { "type": "string", "description": "The default text. The maximum length is 255 characters." },
+ "text": {
+ "type": "string",
+ "description": "The default text. The maximum length is 255 characters."
+ },
"type": { "type": "string" }
},
"description": "The default text for a read only custom field."
@@ -34368,7 +37489,10 @@
"required": ["type"],
"type": "object",
"properties": {
- "text": { "type": "string", "description": "The default text. The maximum length is 32767 characters." },
+ "text": {
+ "type": "string",
+ "description": "The default text. The maximum length is 32767 characters."
+ },
"type": { "type": "string" }
},
"description": "The default text for a text area custom field."
@@ -34377,7 +37501,10 @@
"required": ["type"],
"type": "object",
"properties": {
- "text": { "type": "string", "description": "The default text. The maximum length is 254 characters." },
+ "text": {
+ "type": "string",
+ "description": "The default text. The maximum length is 254 characters."
+ },
"type": { "type": "string" }
},
"description": "The default text for a text custom field."
@@ -34406,7 +37533,12 @@
"PageBeanCustomFieldContextDefaultValue": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34431,7 +37563,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34525,8 +37661,16 @@
"required": ["issueTypeId", "projectId"],
"type": "object",
"properties": {
- "projectId": { "type": "string", "description": "The ID of the project.", "writeOnly": true },
- "issueTypeId": { "type": "string", "description": "The ID of the issue type.", "writeOnly": true }
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the project.",
+ "writeOnly": true
+ },
+ "issueTypeId": {
+ "type": "string",
+ "description": "The ID of the issue type.",
+ "writeOnly": true
+ }
},
"additionalProperties": false,
"description": "The project and issue type mapping.",
@@ -34560,7 +37704,12 @@
"PageBeanContextForProjectAndIssueType": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34585,7 +37734,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34613,7 +37766,10 @@
"properties": {
"contextId": { "type": "string", "description": "The ID of the context." },
"issueTypeId": { "type": "string", "description": "The ID of the issue type." },
- "isAnyIssueType": { "type": "boolean", "description": "Whether the context is mapped to any issue type." }
+ "isAnyIssueType": {
+ "type": "boolean",
+ "description": "Whether the context is mapped to any issue type."
+ }
},
"additionalProperties": false,
"description": "Mapping of an issue type to a context."
@@ -34621,7 +37777,12 @@
"PageBeanIssueTypeToContextMapping": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34646,7 +37807,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34714,7 +37879,10 @@
"MultipleCustomFieldValuesUpdateDetails": {
"type": "object",
"properties": {
- "updates": { "type": "array", "items": { "$ref": "#/components/schemas/MultipleCustomFieldValuesUpdate" } }
+ "updates": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/MultipleCustomFieldValuesUpdate" }
+ }
},
"additionalProperties": false,
"description": "List of updates for a custom fields.",
@@ -34739,7 +37907,12 @@
"PageBeanContextualConfiguration": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34764,7 +37937,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34795,14 +37972,23 @@
"AttachmentMetadata": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the attachment.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the attachment.",
+ "format": "int64",
+ "readOnly": true
+ },
"self": {
"type": "string",
"description": "The URL of the attachment metadata details.",
"format": "uri",
"readOnly": true
},
- "filename": { "type": "string", "description": "The name of the attachment file.", "readOnly": true },
+ "filename": {
+ "type": "string",
+ "description": "The name of the attachment file.",
+ "readOnly": true
+ },
"author": {
"description": "Details of the user who attached the file.",
"readOnly": true,
@@ -34820,14 +38006,22 @@
"format": "int64",
"readOnly": true
},
- "mimeType": { "type": "string", "description": "The MIME type of the attachment.", "readOnly": true },
+ "mimeType": {
+ "type": "string",
+ "description": "The MIME type of the attachment.",
+ "readOnly": true
+ },
"properties": {
"type": "object",
"additionalProperties": { "readOnly": true },
"description": "Additional properties of the attachment.",
"readOnly": true
},
- "content": { "type": "string", "description": "The URL of the attachment.", "readOnly": true },
+ "content": {
+ "type": "string",
+ "description": "The URL of the attachment.",
+ "readOnly": true
+ },
"thumbnail": {
"type": "string",
"description": "The URL of a thumbnail representing the attachment.",
@@ -34889,23 +38083,42 @@
"moreAvailable": { "type": "boolean" },
"totalNumberOfEntriesAvailable": { "type": "integer", "format": "int32" },
"totalEntryCount": { "type": "integer", "format": "int32" },
- "entries": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentArchiveEntry" } }
+ "entries": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/AttachmentArchiveEntry" }
+ }
},
"additionalProperties": false
},
"AttachmentArchiveItemReadable": {
"type": "object",
"properties": {
- "path": { "type": "string", "description": "The path of the archive item.", "readOnly": true },
+ "path": {
+ "type": "string",
+ "description": "The path of the archive item.",
+ "readOnly": true
+ },
"index": {
"type": "integer",
"description": "The position of the item within the archive.",
"format": "int64",
"readOnly": true
},
- "size": { "type": "string", "description": "The size of the archive item.", "readOnly": true },
- "mediaType": { "type": "string", "description": "The MIME type of the archive item.", "readOnly": true },
- "label": { "type": "string", "description": "The label for the archive item.", "readOnly": true }
+ "size": {
+ "type": "string",
+ "description": "The size of the archive item.",
+ "readOnly": true
+ },
+ "mediaType": {
+ "type": "string",
+ "description": "The MIME type of the archive item.",
+ "readOnly": true
+ },
+ "label": {
+ "type": "string",
+ "description": "The label for the archive item.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Metadata for an item in an attachment archive."
@@ -34913,8 +38126,17 @@
"AttachmentArchiveMetadataReadable": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the attachment.", "format": "int64", "readOnly": true },
- "name": { "type": "string", "description": "The name of the archive file.", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the attachment.",
+ "format": "int64",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the archive file.",
+ "readOnly": true
+ },
"entries": {
"type": "array",
"description": "The list of the items included in the archive.",
@@ -34927,7 +38149,11 @@
"format": "int64",
"readOnly": true
},
- "mediaType": { "type": "string", "description": "The MIME type of the attachment.", "readOnly": true }
+ "mediaType": {
+ "type": "string",
+ "description": "The MIME type of the attachment.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Metadata for an archive (for example a zip) and its contents."
@@ -34935,7 +38161,12 @@
"PageBeanUiModificationDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -34960,7 +38191,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -34975,7 +38210,11 @@
"required": ["issueTypeId", "projectId", "viewType"],
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the UI modification context.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the UI modification context.",
+ "readOnly": true
+ },
"projectId": { "type": "string", "description": "The project ID of the context." },
"issueTypeId": { "type": "string", "description": "The issue type ID of the context." },
"viewType": {
@@ -34996,7 +38235,11 @@
"required": ["id", "name", "self"],
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the UI modification.", "readOnly": true },
+ "id": {
+ "type": "string",
+ "description": "The ID of the UI modification.",
+ "readOnly": true
+ },
"name": {
"type": "string",
"description": "The name of the UI modification. The maximum length is 255 characters.",
@@ -35007,7 +38250,11 @@
"description": "The description of the UI modification. The maximum length is 255 characters.",
"readOnly": true
},
- "self": { "type": "string", "description": "The URL of the UI modification.", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the UI modification.",
+ "readOnly": true
+ },
"data": {
"type": "string",
"description": "The data of the UI modification. The maximum size of the data is 50000 characters.",
@@ -35056,8 +38303,16 @@
"required": ["id", "self"],
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the UI modification.", "readOnly": true },
- "self": { "type": "string", "description": "The URL of the UI modification.", "readOnly": true }
+ "id": {
+ "type": "string",
+ "description": "The ID of the UI modification.",
+ "readOnly": true
+ },
+ "self": {
+ "type": "string",
+ "description": "The URL of the UI modification.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Identifiers for a UI modification."
@@ -35094,7 +38349,10 @@
"required": ["issueTypeId", "issueTypeScreenSchemeId", "screenSchemeId"],
"type": "object",
"properties": {
- "issueTypeScreenSchemeId": { "type": "string", "description": "The ID of the issue type screen scheme." },
+ "issueTypeScreenSchemeId": {
+ "type": "string",
+ "description": "The ID of the issue type screen scheme."
+ },
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type or *default*. Only issue types used in classic projects are accepted. When creating an issue screen scheme, an entry for *default* must be provided and defines the mapping for all issue types without a screen scheme. Otherwise, a *default* entry can't be provided."
@@ -35107,7 +38365,12 @@
"PageBeanIssueTypeScreenSchemeItem": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -35132,7 +38395,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -35149,7 +38416,10 @@
"properties": {
"id": { "type": "string", "description": "The ID of the issue type screen scheme." },
"name": { "type": "string", "description": "The name of the issue type screen scheme." },
- "description": { "type": "string", "description": "The description of the issue type screen scheme." }
+ "description": {
+ "type": "string",
+ "description": "The description of the issue type screen scheme."
+ }
},
"additionalProperties": false,
"description": "Details of an issue type screen scheme."
@@ -35174,7 +38444,12 @@
"PageBeanIssueTypeScreenSchemesProjects": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -35199,7 +38474,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -35213,7 +38492,12 @@
"PageBeanIssueTypeScreenScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -35238,7 +38522,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -35252,7 +38540,12 @@
"PageBeanProjectDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -35277,7 +38570,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -35296,7 +38593,11 @@
"description": "The ID of the issue type screen scheme.",
"writeOnly": true
},
- "projectId": { "type": "string", "description": "The ID of the project.", "writeOnly": true }
+ "projectId": {
+ "type": "string",
+ "description": "The ID of the project.",
+ "writeOnly": true
+ }
},
"additionalProperties": false,
"description": "Associated issue type screen scheme and project."
@@ -35348,7 +38649,11 @@
"required": ["id"],
"type": "object",
"properties": {
- "id": { "type": "string", "description": "The ID of the issue type screen scheme.", "readOnly": true }
+ "id": {
+ "type": "string",
+ "description": "The ID of the issue type screen scheme.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "The ID of an issue type screen scheme."
@@ -35388,7 +38693,11 @@
"required": ["screenSchemeId"],
"type": "object",
"properties": {
- "screenSchemeId": { "type": "string", "description": "The ID of the screen scheme.", "writeOnly": true }
+ "screenSchemeId": {
+ "type": "string",
+ "description": "The ID of the screen scheme.",
+ "writeOnly": true
+ }
},
"additionalProperties": false,
"description": "The ID of a screen scheme."
@@ -35396,7 +38705,12 @@
"PageBeanScreenScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -35421,7 +38735,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -35435,9 +38753,16 @@
"ScreenScheme": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the screen scheme.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the screen scheme.",
+ "format": "int64"
+ },
"name": { "type": "string", "description": "The name of the screen scheme." },
- "description": { "type": "string", "description": "The description of the screen scheme." },
+ "description": {
+ "type": "string",
+ "description": "The description of the screen scheme."
+ },
"screens": {
"description": "The IDs of the screens for the screen types of the screen scheme.",
"allOf": [{ "$ref": "#/components/schemas/ScreenTypes" }]
@@ -35454,9 +38779,21 @@
"required": ["defaultScreen"],
"type": "object",
"properties": {
- "edit": { "type": "integer", "description": "The ID of the edit screen.", "format": "int64" },
- "create": { "type": "integer", "description": "The ID of the create screen.", "format": "int64" },
- "view": { "type": "integer", "description": "The ID of the view screen.", "format": "int64" },
+ "edit": {
+ "type": "integer",
+ "description": "The ID of the edit screen.",
+ "format": "int64"
+ },
+ "create": {
+ "type": "integer",
+ "description": "The ID of the create screen.",
+ "format": "int64"
+ },
+ "view": {
+ "type": "integer",
+ "description": "The ID of the view screen.",
+ "format": "int64"
+ },
"default": {
"type": "integer",
"description": "The ID of the default screen. Required when creating a screen scheme.",
@@ -35642,7 +38979,11 @@
"format": "int64",
"readOnly": true
},
- "description": { "type": "string", "description": "The description of the project role.", "readOnly": true },
+ "description": {
+ "type": "string",
+ "description": "The description of the project role.",
+ "readOnly": true
+ },
"admin": {
"type": "boolean",
"description": "Whether this role is the admin role for the project.",
@@ -35658,7 +38999,10 @@
"description": "Whether the roles are configurable for this project.",
"readOnly": true
},
- "translatedName": { "type": "string", "description": "The translated name of the project role." },
+ "translatedName": {
+ "type": "string",
+ "description": "The translated name of the project role."
+ },
"default": {
"type": "boolean",
"description": "Whether this role is the default role for the project.",
@@ -35671,8 +39015,17 @@
"IssueTypeInfo": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the issue type.", "format": "int64", "readOnly": true },
- "name": { "type": "string", "description": "The name of the issue type.", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the issue type.",
+ "format": "int64",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue type.",
+ "readOnly": true
+ },
"avatarId": {
"type": "integer",
"description": "The avatar of the issue type.",
@@ -35717,7 +39070,11 @@
"format": "int32",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the issue type hierarchy level.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the issue type hierarchy level.",
+ "readOnly": true
+ },
"issueTypes": {
"type": "array",
"description": "The list of issue types in the hierarchy level.",
@@ -35731,7 +39088,9 @@
"CustomContextVariable": {
"required": ["type"],
"type": "object",
- "properties": { "type": { "type": "string", "description": "Type of custom context variable." } },
+ "properties": {
+ "type": { "type": "string", "description": "Type of custom context variable." }
+ },
"additionalProperties": false,
"discriminator": {
"propertyName": "type",
@@ -35750,7 +39109,11 @@
"IdOrKeyBean": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the referenced item.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the referenced item.",
+ "format": "int64"
+ },
"key": { "type": "string", "description": "The key of the referenced item." }
},
"additionalProperties": false
@@ -35881,7 +39244,11 @@
"required": ["count", "maxResults", "startAt", "totalCount"],
"type": "object",
"properties": {
- "startAt": { "type": "integer", "description": "The index of the first issue.", "format": "int64" },
+ "startAt": {
+ "type": "integer",
+ "description": "The index of the first issue.",
+ "format": "int64"
+ },
"maxResults": {
"type": "integer",
"description": "The maximum number of issues that could be loaded in this evaluation.",
@@ -36021,7 +39388,10 @@
"type": "boolean",
"description": "Whether the expression is valid and the interpreter will evaluate it. Note that the expression may fail at runtime (for example, if it executes too many expensive operations)."
},
- "type": { "type": "string", "description": "EXPERIMENTAL. The inferred type of the expression." },
+ "type": {
+ "type": "string",
+ "description": "EXPERIMENTAL. The inferred type of the expression."
+ },
"complexity": { "$ref": "#/components/schemas/JiraExpressionComplexity" }
},
"additionalProperties": false,
@@ -36051,19 +39421,30 @@
"required": ["message", "type"],
"type": "object",
"properties": {
- "line": { "type": "integer", "description": "The text line in which the error occurred.", "format": "int32" },
+ "line": {
+ "type": "integer",
+ "description": "The text line in which the error occurred.",
+ "format": "int32"
+ },
"column": {
"type": "integer",
"description": "The text column in which the error occurred.",
"format": "int32"
},
- "expression": { "type": "string", "description": "The part of the expression in which the error occurred." },
+ "expression": {
+ "type": "string",
+ "description": "The part of the expression in which the error occurred."
+ },
"message": {
"type": "string",
"description": "Details about the error.",
"example": "!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered."
},
- "type": { "type": "string", "description": "The error type.", "enum": ["syntax", "type", "other"] }
+ "type": {
+ "type": "string",
+ "description": "The error type.",
+ "enum": ["syntax", "type", "other"]
+ }
},
"additionalProperties": false,
"description": "Details about syntax and type errors. The error details apply to the entire expression, unless the object includes:\n\n * `line` and `column`\n * `expression`"
@@ -36091,7 +39472,11 @@
"description": "Whether the dashboard is selected as a favorite by the user.",
"readOnly": true
},
- "name": { "type": "string", "description": "The name of the dashboard.", "readOnly": true },
+ "name": {
+ "type": "string",
+ "description": "The name of the dashboard.",
+ "readOnly": true
+ },
"owner": {
"description": "The owner of the dashboard.",
"readOnly": true,
@@ -36133,7 +39518,11 @@
"format": "int32",
"readOnly": true
},
- "view": { "type": "string", "description": "The URL of the dashboard.", "readOnly": true },
+ "view": {
+ "type": "string",
+ "description": "The URL of the dashboard.",
+ "readOnly": true
+ },
"isWritable": {
"type": "boolean",
"description": "Whether the current user has permission to edit the dashboard.",
@@ -36169,7 +39558,11 @@
"description": "The URL of the previous page of results, if any.",
"readOnly": true
},
- "next": { "type": "string", "description": "The URL of the next page of results, if any.", "readOnly": true },
+ "next": {
+ "type": "string",
+ "description": "The URL of the next page of results, if any.",
+ "readOnly": true
+ },
"dashboards": {
"type": "array",
"description": "List of dashboards.",
@@ -36183,7 +39576,12 @@
"PageBeanDashboard": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -36208,7 +39606,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -36243,8 +39645,16 @@
"required": ["title"],
"type": "object",
"properties": {
- "moduleKey": { "type": "string", "description": "The module key of the gadget type.", "readOnly": true },
- "uri": { "type": "string", "description": "The URI of the gadget type.", "readOnly": true },
+ "moduleKey": {
+ "type": "string",
+ "description": "The module key of the gadget type.",
+ "readOnly": true
+ },
+ "uri": {
+ "type": "string",
+ "description": "The URI of the gadget type.",
+ "readOnly": true
+ },
"title": { "type": "string", "description": "The title of the gadget.", "readOnly": true }
},
"additionalProperties": false,
@@ -36274,8 +39684,16 @@
"format": "int64",
"readOnly": true
},
- "moduleKey": { "type": "string", "description": "The module key of the gadget type.", "readOnly": true },
- "uri": { "type": "string", "description": "The URI of the gadget type.", "readOnly": true },
+ "moduleKey": {
+ "type": "string",
+ "description": "The module key of the gadget type.",
+ "readOnly": true
+ },
+ "uri": {
+ "type": "string",
+ "description": "The URI of the gadget type.",
+ "readOnly": true
+ },
"color": {
"type": "string",
"description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.",
@@ -36339,7 +39757,11 @@
"description": "The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it.",
"allOf": [{ "$ref": "#/components/schemas/DashboardGadgetPosition" }]
},
- "title": { "type": "string", "description": "The title of the gadget.", "writeOnly": true },
+ "title": {
+ "type": "string",
+ "description": "The title of the gadget.",
+ "writeOnly": true
+ },
"ignoreUriAndModuleKeyValidation": {
"type": "boolean",
"description": "Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.",
@@ -36352,7 +39774,11 @@
"DashboardGadgetUpdateRequest": {
"type": "object",
"properties": {
- "title": { "type": "string", "description": "The title of the gadget.", "writeOnly": true },
+ "title": {
+ "type": "string",
+ "description": "The title of the gadget.",
+ "writeOnly": true
+ },
"color": {
"type": "string",
"description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.",
@@ -36369,7 +39795,11 @@
"AnnouncementBannerConfiguration": {
"type": "object",
"properties": {
- "message": { "type": "string", "description": "The text on the announcement banner.", "readOnly": true },
+ "message": {
+ "type": "string",
+ "description": "The text on the announcement banner.",
+ "readOnly": true
+ },
"isDismissible": {
"type": "boolean",
"description": "Flag indicating if the announcement banner can be dismissed by the user.",
@@ -36453,7 +39883,11 @@
"description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](#api-rest-api-3-permissions-get) to get the list of permissions."
},
"name": { "type": "string", "description": "The name of the permission." },
- "type": { "type": "string", "description": "The type of the permission.", "enum": ["GLOBAL", "PROJECT"] },
+ "type": {
+ "type": "string",
+ "description": "The type of the permission.",
+ "enum": ["GLOBAL", "PROJECT"]
+ },
"description": { "type": "string", "description": "The description of the permission." },
"havePermission": {
"type": "boolean",
@@ -36558,7 +39992,11 @@
"required": ["permissions"],
"type": "object",
"properties": {
- "permissions": { "type": "array", "description": "A list of permission keys.", "items": { "type": "string" } }
+ "permissions": {
+ "type": "array",
+ "description": "A list of permission keys.",
+ "items": { "type": "string" }
+ }
},
"additionalProperties": false
},
@@ -36578,7 +40016,12 @@
"ProjectIdentifierBean": {
"type": "object",
"properties": {
- "id": { "type": "integer", "description": "The ID of the project.", "format": "int64", "readOnly": true },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the project.",
+ "format": "int64",
+ "readOnly": true
+ },
"key": { "type": "string", "description": "The key of the project.", "readOnly": true }
},
"additionalProperties": false,
@@ -36600,7 +40043,12 @@
"PageBeanGroupDetails": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -36625,7 +40073,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -36659,7 +40111,10 @@
"required": ["matches"],
"type": "object",
"properties": {
- "matches": { "type": "array", "items": { "$ref": "#/components/schemas/IssueMatchesForJQL" } }
+ "matches": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/IssueMatchesForJQL" }
+ }
},
"additionalProperties": false,
"description": "A list of matched issues or errors for each JQL query, in the order the JQL queries were passed."
@@ -36711,7 +40166,9 @@
"description": "List of issues to perform the bulk operation on.",
"items": { "type": "integer", "format": "int64" }
},
- "currentValue": { "description": "The value of properties to perform the bulk operation on." },
+ "currentValue": {
+ "description": "The value of properties to perform the bulk operation on."
+ },
"hasProperty": {
"type": "boolean",
"description": "Whether the bulk operation occurs only when the property is present on or absent from an issue."
@@ -36729,7 +40186,9 @@
"description": "List of issues to perform the bulk delete operation on.",
"items": { "type": "integer", "format": "int64" }
},
- "currentValue": { "description": "The value of properties to perform the bulk operation on." }
+ "currentValue": {
+ "description": "The value of properties to perform the bulk operation on."
+ }
},
"additionalProperties": false,
"description": "Bulk operation filter details."
@@ -36782,7 +40241,10 @@
"valueNode": { "type": "boolean" },
"missingNode": { "type": "boolean" },
"numberValue": { "type": "number" },
- "numberType": { "type": "string", "enum": ["INT", "LONG", "BIG_INTEGER", "FLOAT", "DOUBLE", "BIG_DECIMAL"] },
+ "numberType": {
+ "type": "string",
+ "enum": ["INT", "LONG", "BIG_INTEGER", "FLOAT", "DOUBLE", "BIG_DECIMAL"]
+ },
"intValue": { "type": "integer", "format": "int32" },
"longValue": { "type": "integer", "format": "int64" },
"bigIntegerValue": { "type": "integer" },
@@ -36805,7 +40267,11 @@
"minProperties": 1,
"type": "object",
"properties": {
- "issueID": { "type": "integer", "description": "The ID of the issue.", "format": "int64" },
+ "issueID": {
+ "type": "integer",
+ "description": "The ID of the issue.",
+ "format": "int64"
+ },
"properties": {
"maxProperties": 10,
"minProperties": 1,
@@ -36838,7 +40304,11 @@
"type": "string",
"description": "Expand options that include additional event notification details in the response."
},
- "id": { "type": "integer", "description": "The ID of the notification.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the notification.",
+ "format": "int64"
+ },
"notificationType": {
"type": "string",
"description": "Identifies the recipients of the notification.",
@@ -36865,7 +40335,10 @@
"type": "string",
"description": "The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType` is:\n\n * `User`, `recipient` is the user account ID.\n * `Group`, `recipient` is the group ID.\n * `ProjectRole`, `recipient` is the project role ID.\n * `UserCustomField`, `recipient` is the ID of the custom field.\n * `GroupCustomField`, `recipient` is the ID of the custom field."
},
- "group": { "description": "The specified group.", "allOf": [{ "$ref": "#/components/schemas/GroupName" }] },
+ "group": {
+ "description": "The specified group.",
+ "allOf": [{ "$ref": "#/components/schemas/GroupName" }]
+ },
"field": {
"description": "The custom user or group field.",
"allOf": [{ "$ref": "#/components/schemas/FieldDetails" }]
@@ -36875,7 +40348,10 @@
"description": "The specified project role.",
"allOf": [{ "$ref": "#/components/schemas/ProjectRole" }]
},
- "user": { "description": "The specified user.", "allOf": [{ "$ref": "#/components/schemas/UserDetails" }] }
+ "user": {
+ "description": "The specified user.",
+ "allOf": [{ "$ref": "#/components/schemas/UserDetails" }]
+ }
},
"additionalProperties": false,
"description": "Details about a notification associated with an event."
@@ -36905,10 +40381,17 @@
"type": "string",
"description": "Expand options that include additional notification scheme details in the response."
},
- "id": { "type": "integer", "description": "The ID of the notification scheme.", "format": "int64" },
+ "id": {
+ "type": "integer",
+ "description": "The ID of the notification scheme.",
+ "format": "int64"
+ },
"self": { "type": "string" },
"name": { "type": "string", "description": "The name of the notification scheme." },
- "description": { "type": "string", "description": "The description of the notification scheme." },
+ "description": {
+ "type": "string",
+ "description": "The description of the notification scheme."
+ },
"notificationSchemeEvents": {
"type": "array",
"description": "The notification events and associated recipients.",
@@ -36926,7 +40409,10 @@
"type": "object",
"properties": {
"event": { "$ref": "#/components/schemas/NotificationEvent" },
- "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/EventNotification" } }
+ "notifications": {
+ "type": "array",
+ "items": { "$ref": "#/components/schemas/EventNotification" }
+ }
},
"additionalProperties": false,
"description": "Details about a notification scheme event."
@@ -36934,7 +40420,12 @@
"PageBeanNotificationScheme": {
"type": "object",
"properties": {
- "self": { "type": "string", "description": "The URL of the page.", "format": "uri", "readOnly": true },
+ "self": {
+ "type": "string",
+ "description": "The URL of the page.",
+ "format": "uri",
+ "readOnly": true
+ },
"nextPage": {
"type": "string",
"description": "If there is another page of results, the URL of the next page.",
@@ -36959,7 +40450,11 @@
"format": "int64",
"readOnly": true
},
- "isLast": { "type": "boolean", "description": "Whether this is the last page.", "readOnly": true },
+ "isLast": {
+ "type": "boolean",
+ "description": "Whether this is the last page.",
+ "readOnly": true
+ },
"values": {
"type": "array",
"description": "The list of items.",
@@ -37086,7 +40581,11 @@
"type": "object",
"properties": {
"field": { "$ref": "#/components/schemas/JqlQueryField" },
- "operator": { "type": "string", "description": "The operator applied to the field.", "enum": ["changed"] },
+ "operator": {
+ "type": "string",
+ "description": "The operator applied to the field.",
+ "enum": ["changed"]
+ },
"predicates": {
"type": "array",
"description": "The list of time predicates.",
@@ -37202,8 +40701,16 @@
"required": ["entity", "key", "path"],
"type": "object",
"properties": {
- "entity": { "type": "string", "description": "The object on which the property is set.", "example": "issue" },
- "key": { "type": "string", "description": "The key of the property.", "example": "stats" },
+ "entity": {
+ "type": "string",
+ "description": "The object on which the property is set.",
+ "example": "issue"
+ },
+ "key": {
+ "type": "string",
+ "description": "The key of the property.",
+ "example": "stats"
+ },
"path": {
"type": "string",
"description": "The path in the property value to query.",
@@ -37258,7 +40765,11 @@
"required": ["keyword"],
"type": "object",
"properties": {
- "keyword": { "type": "string", "description": "The keyword that is the operand value.", "enum": ["empty"] }
+ "keyword": {
+ "type": "string",
+ "description": "The keyword that is the operand value.",
+ "enum": ["empty"]
+ }
},
"description": "An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords."
},
@@ -37294,7 +40805,10 @@
"required": ["query"],
"type": "object",
"properties": {
- "query": { "type": "string", "description": "The JQL query that was parsed and validated." },
+ "query": {
+ "type": "string",
+ "description": "The JQL query that was parsed and validated."
+ },
"structure": {
"description": "The syntax tree of the query. Empty if the query was invalid.",
"allOf": [{ "$ref": "#/components/schemas/JqlQuery" }]
@@ -37331,7 +40845,11 @@
"ProjectType": {
"type": "object",
"properties": {
- "key": { "type": "string", "description": "The key of the project type.", "readOnly": true },
+ "key": {
+ "type": "string",
+ "description": "The key of the project type.",
+ "readOnly": true
+ },
"formattedKey": {
"type": "string",
"description": "The formatted key of the project type.",
@@ -37342,8 +40860,16 @@
"description": "The key of the project type's description.",
"readOnly": true
},
- "icon": { "type": "string", "description": "The icon of the project type.", "readOnly": true },
- "color": { "type": "string", "description": "The color of the project type.", "readOnly": true }
+ "icon": {
+ "type": "string",
+ "description": "The icon of the project type.",
+ "readOnly": true
+ },
+ "color": {
+ "type": "string",
+ "description": "The color of the project type.",
+ "readOnly": true
+ }
},
"additionalProperties": false,
"description": "Details about a project type."
@@ -37352,7 +40878,10 @@
"required": ["message", "statusCode"],
"type": "object",
"properties": {
- "message": { "type": "string", "description": "The human-readable message that describes the result." },
+ "message": {
+ "type": "string",
+ "description": "The human-readable message that describes the result."
+ },
"statusCode": { "type": "integer", "description": "The status code of the response." }
},
"additionalProperties": false,
@@ -37380,7 +40909,9 @@
{
"keyConfigurations": [
{
- "extractions": [{ "objectName": "extension", "type": "text", "alias": "attachmentExtension" }],
+ "extractions": [
+ { "objectName": "extension", "type": "text", "alias": "attachmentExtension" }
+ ],
"propertyKey": "attachment"
}
],
@@ -37472,9 +41003,21 @@
"required": ["entityId", "key", "value"],
"type": "object",
"properties": {
- "entityId": { "type": "number", "description": "The entity property ID.", "example": 123 },
- "key": { "type": "string", "description": "The entity property key.", "example": "mykey" },
- "value": { "type": "string", "description": "The new value of the entity property.", "example": "newValue" }
+ "entityId": {
+ "type": "number",
+ "description": "The entity property ID.",
+ "example": 123
+ },
+ "key": {
+ "type": "string",
+ "description": "The entity property key.",
+ "example": "mykey"
+ },
+ "value": {
+ "type": "string",
+ "description": "The new value of the entity property.",
+ "example": "newValue"
+ }
}
},
"ConnectCustomFieldValue": {
@@ -37495,7 +41038,11 @@
]
},
"issueID": { "type": "integer", "description": "The issue ID.", "writeOnly": true },
- "fieldID": { "type": "integer", "description": "The custom field ID.", "writeOnly": true },
+ "fieldID": {
+ "type": "integer",
+ "description": "The custom field ID.",
+ "writeOnly": true
+ },
"string": {
"type": "string",
"description": "The value of string type custom field when `_type` is `StringIssueField`."
@@ -37535,7 +41082,11 @@
}
},
"securitySchemes": {
- "basicAuth": { "type": "http", "description": "You can access this resource via basic auth.", "scheme": "basic" },
+ "basicAuth": {
+ "type": "http",
+ "description": "You can access this resource via basic auth.",
+ "scheme": "basic"
+ },
"OAuth2": {
"type": "oauth2",
"description": "OAuth2 scopes for Jira",
diff --git a/packages/loaders/openapi/tests/fixtures/kubernetes.json b/packages/loaders/openapi/tests/fixtures/kubernetes.json
index c86a1efa90dac..33ddc11e247cc 100644
--- a/packages/loaders/openapi/tests/fixtures/kubernetes.json
+++ b/packages/loaders/openapi/tests/fixtures/kubernetes.json
@@ -728,7 +728,12 @@
"type": "integer"
}
},
- "required": ["currentNumberScheduled", "numberMisscheduled", "desiredNumberScheduled", "numberReady"],
+ "required": [
+ "currentNumberScheduled",
+ "numberMisscheduled",
+ "desiredNumberScheduled",
+ "numberReady"
+ ],
"type": "object"
},
"io.k8s.api.apps.v1.DaemonSetUpdateStrategy": {
@@ -20559,7 +20564,12 @@
"consumes": ["*/*"],
"description": "read log of the specified Pod",
"operationId": "readCoreV1NamespacedPodLog",
- "produces": ["text/plain", "application/json", "application/yaml", "application/vnd.kubernetes.protobuf"],
+ "produces": [
+ "text/plain",
+ "application/json",
+ "application/yaml",
+ "application/vnd.kubernetes.protobuf"
+ ],
"responses": {
"200": {
"description": "OK",
diff --git a/packages/loaders/openapi/tests/fixtures/stripe.json b/packages/loaders/openapi/tests/fixtures/stripe.json
index 1da5eb3826dd1..36fb07fd39e6d 100644
--- a/packages/loaders/openapi/tests/fixtures/stripe.json
+++ b/packages/loaders/openapi/tests/fixtures/stripe.json
@@ -697,7 +697,16 @@
"type": "string"
}
},
- "required": ["created", "fingerprint", "id", "livemode", "object", "reusable", "used", "username"],
+ "required": [
+ "created",
+ "fingerprint",
+ "id",
+ "livemode",
+ "object",
+ "reusable",
+ "used",
+ "username"
+ ],
"title": "AlipayAccount",
"type": "object",
"x-expandableFields": ["customer"],
@@ -1937,7 +1946,16 @@
"type": "string"
}
},
- "required": ["brand", "exp_month", "exp_year", "funding", "id", "last4", "metadata", "object"],
+ "required": [
+ "brand",
+ "exp_month",
+ "exp_year",
+ "funding",
+ "id",
+ "last4",
+ "metadata",
+ "object"
+ ],
"title": "Card",
"type": "object",
"x-expandableFields": ["account", "customer", "recipient"],
@@ -2598,7 +2616,24 @@
},
"locale": {
"description": "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.",
- "enum": ["auto", "da", "de", "en", "es", "fi", "fr", "it", "ja", "ms", "nb", "nl", "pl", "pt", "sv", "zh"],
+ "enum": [
+ "auto",
+ "da",
+ "de",
+ "en",
+ "es",
+ "fi",
+ "fr",
+ "it",
+ "ja",
+ "ms",
+ "nb",
+ "nl",
+ "pl",
+ "pt",
+ "sv",
+ "zh"
+ ],
"nullable": true,
"type": "string",
"x-stripeBypassValidation": true
@@ -2694,10 +2729,23 @@
"type": "string"
}
},
- "required": ["cancel_url", "id", "livemode", "object", "payment_method_types", "success_url"],
+ "required": [
+ "cancel_url",
+ "id",
+ "livemode",
+ "object",
+ "payment_method_types",
+ "success_url"
+ ],
"title": "Session",
"type": "object",
- "x-expandableFields": ["customer", "display_items", "payment_intent", "setup_intent", "subscription"],
+ "x-expandableFields": [
+ "customer",
+ "display_items",
+ "payment_intent",
+ "setup_intent",
+ "subscription"
+ ],
"x-resourceId": "checkout.session"
},
"checkout_session_custom_display_item_description": {
@@ -2999,7 +3047,16 @@
"type": "boolean"
}
},
- "required": ["created", "duration", "id", "livemode", "metadata", "object", "times_redeemed", "valid"],
+ "required": [
+ "created",
+ "duration",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "times_redeemed",
+ "valid"
+ ],
"title": "Coupon",
"type": "object",
"x-expandableFields": [],
@@ -3611,7 +3668,17 @@
"type": "string"
}
},
- "required": ["amount", "created", "currency", "customer", "ending_balance", "id", "livemode", "object", "type"],
+ "required": [
+ "amount",
+ "created",
+ "currency",
+ "customer",
+ "ending_balance",
+ "id",
+ "livemode",
+ "object",
+ "type"
+ ],
"title": "CustomerBalanceTransaction",
"type": "object",
"x-expandableFields": ["credit_note", "customer", "invoice"],
@@ -4420,7 +4487,13 @@
],
"title": "Dispute",
"type": "object",
- "x-expandableFields": ["balance_transactions", "charge", "evidence", "evidence_details", "payment_intent"],
+ "x-expandableFields": [
+ "balance_transactions",
+ "charge",
+ "evidence",
+ "evidence_details",
+ "payment_intent"
+ ],
"x-resourceId": "dispute"
},
"dispute_evidence": {
@@ -6096,14 +6169,31 @@
],
"title": "InvoiceItem",
"type": "object",
- "x-expandableFields": ["customer", "invoice", "period", "plan", "subscription", "tax_rates"],
+ "x-expandableFields": [
+ "customer",
+ "invoice",
+ "period",
+ "plan",
+ "subscription",
+ "tax_rates"
+ ],
"x-resourceId": "invoiceitem"
},
"invoices_resource_invoice_tax_id": {
"properties": {
"type": {
"description": "The type of the tax ID, one of `au_abn`, `ch_vat`, `eu_vat`, `in_gst`, `mx_rfc`, `no_vat`, `nz_gst`, `unknown`, or `za_vat`",
- "enum": ["au_abn", "ch_vat", "eu_vat", "in_gst", "mx_rfc", "no_vat", "nz_gst", "unknown", "za_vat"],
+ "enum": [
+ "au_abn",
+ "ch_vat",
+ "eu_vat",
+ "in_gst",
+ "mx_rfc",
+ "no_vat",
+ "nz_gst",
+ "unknown",
+ "za_vat"
+ ],
"type": "string"
},
"value": {
@@ -6524,7 +6614,13 @@
],
"title": "IssuingCard",
"type": "object",
- "x-expandableFields": ["authorization_controls", "cardholder", "pin", "replacement_for", "shipping"],
+ "x-expandableFields": [
+ "authorization_controls",
+ "cardholder",
+ "pin",
+ "replacement_for",
+ "shipping"
+ ],
"x-resourceId": "issuing.card"
},
"issuing.card_details": {
@@ -6695,7 +6791,13 @@
],
"title": "IssuingCardholder",
"type": "object",
- "x-expandableFields": ["authorization_controls", "billing", "company", "individual", "requirements"],
+ "x-expandableFields": [
+ "authorization_controls",
+ "billing",
+ "company",
+ "individual",
+ "requirements"
+ ],
"x-resourceId": "issuing.cardholder"
},
"issuing.dispute": {
@@ -7034,7 +7136,14 @@
},
"type": {
"description": "The nature of the transaction.",
- "enum": ["capture", "cash_withdrawal", "dispute", "dispute_loss", "refund", "refund_reversal"],
+ "enum": [
+ "capture",
+ "cash_withdrawal",
+ "dispute",
+ "dispute_loss",
+ "refund",
+ "refund_reversal"
+ ],
"type": "string"
}
},
@@ -7102,7 +7211,15 @@
"type": "string"
}
},
- "required": ["card", "created", "expires_at", "id", "object", "scope", "verification_method"],
+ "required": [
+ "card",
+ "created",
+ "expires_at",
+ "id",
+ "object",
+ "scope",
+ "verification_method"
+ ],
"title": "IssuingVerification",
"type": "object",
"x-expandableFields": [],
@@ -7270,7 +7387,13 @@
},
"name": {
"description": "Name of the authorization control. One of `allowed_categories`, `blocked_categories`, `max_amount`, `max_approvals`, or `spending_limits`.",
- "enum": ["allowed_categories", "blocked_categories", "max_amount", "max_approvals", "spending_limits"],
+ "enum": [
+ "allowed_categories",
+ "blocked_categories",
+ "max_amount",
+ "max_approvals",
+ "spending_limits"
+ ],
"type": "string"
}
},
@@ -10344,7 +10467,17 @@
"type": "string"
}
},
- "required": ["amount", "created", "currency", "id", "items", "livemode", "metadata", "object", "status"],
+ "required": [
+ "amount",
+ "created",
+ "currency",
+ "id",
+ "items",
+ "livemode",
+ "metadata",
+ "object",
+ "status"
+ ],
"title": "Order",
"type": "object",
"x-expandableFields": [
@@ -11040,7 +11173,14 @@
"required": ["billing_details", "created", "id", "livemode", "metadata", "object", "type"],
"title": "PaymentMethod",
"type": "object",
- "x-expandableFields": ["billing_details", "card", "card_present", "customer", "ideal", "sepa_debit"],
+ "x-expandableFields": [
+ "billing_details",
+ "card",
+ "card_present",
+ "customer",
+ "ideal",
+ "sepa_debit"
+ ],
"x-resourceId": "payment_method"
},
"payment_method_card": {
@@ -11200,7 +11340,14 @@
},
"type": {
"description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
- "enum": ["amex_express_checkout", "apple_pay", "google_pay", "masterpass", "samsung_pay", "visa_checkout"],
+ "enum": [
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
+ ],
"type": "string"
},
"visa_checkout": {
@@ -11832,7 +11979,14 @@
},
"type": {
"description": "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, or `visa_checkout`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.",
- "enum": ["amex_express_checkout", "apple_pay", "google_pay", "masterpass", "samsung_pay", "visa_checkout"],
+ "enum": [
+ "amex_express_checkout",
+ "apple_pay",
+ "google_pay",
+ "masterpass",
+ "samsung_pay",
+ "visa_checkout"
+ ],
"type": "string"
},
"visa_checkout": {
@@ -13086,7 +13240,17 @@
"type": "string"
}
},
- "required": ["created", "id", "images", "livemode", "metadata", "name", "object", "type", "updated"],
+ "required": [
+ "created",
+ "id",
+ "images",
+ "livemode",
+ "metadata",
+ "name",
+ "object",
+ "type",
+ "updated"
+ ],
"title": "Product",
"type": "object",
"x-expandableFields": ["package_dimensions"],
@@ -13512,7 +13676,13 @@
"required": ["created", "id", "livemode", "metadata", "object", "type"],
"title": "TransferRecipient",
"type": "object",
- "x-expandableFields": ["active_account", "cards", "default_card", "migrated_to", "rolled_back_from"],
+ "x-expandableFields": [
+ "active_account",
+ "cards",
+ "default_card",
+ "migrated_to",
+ "rolled_back_from"
+ ],
"x-resourceId": "recipient"
},
"refund": {
@@ -13817,7 +13987,15 @@
"type": "integer"
}
},
- "required": ["data_available_end", "data_available_start", "id", "name", "object", "updated", "version"],
+ "required": [
+ "data_available_end",
+ "data_available_start",
+ "id",
+ "name",
+ "object",
+ "updated",
+ "version"
+ ],
"title": "reporting_report_type",
"type": "object",
"x-expandableFields": [],
@@ -14295,7 +14473,15 @@
"type": "string"
}
},
- "required": ["created", "id", "livemode", "object", "payment_method_types", "status", "usage"],
+ "required": [
+ "created",
+ "id",
+ "livemode",
+ "object",
+ "payment_method_types",
+ "status",
+ "usage"
+ ],
"title": "SetupIntent",
"type": "object",
"x-expandableFields": [
@@ -14730,10 +14916,25 @@
"$ref": "#/components/schemas/source_type_wechat"
}
},
- "required": ["client_secret", "created", "flow", "id", "livemode", "object", "status", "type"],
+ "required": [
+ "client_secret",
+ "created",
+ "flow",
+ "id",
+ "livemode",
+ "object",
+ "status",
+ "type"
+ ],
"title": "Source",
"type": "object",
- "x-expandableFields": ["code_verification", "owner", "receiver", "redirect", "source_order"],
+ "x-expandableFields": [
+ "code_verification",
+ "owner",
+ "receiver",
+ "redirect",
+ "source_order"
+ ],
"x-resourceId": "source"
},
"source_code_verification_flow": {
@@ -15119,7 +15320,17 @@
"type": "string"
}
},
- "required": ["amount", "created", "currency", "id", "livemode", "object", "source", "status", "type"],
+ "required": [
+ "amount",
+ "created",
+ "currency",
+ "id",
+ "livemode",
+ "object",
+ "source",
+ "status",
+ "type"
+ ],
"title": "SourceTransaction",
"type": "object",
"x-expandableFields": [
@@ -16215,7 +16426,15 @@
},
"status": {
"description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically` it becomes `past_due` when payment to renew it fails and `canceled` or `unpaid` (depending on your subscriptions settings) when Stripe has exhausted all payment retry attempts. \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.",
- "enum": ["active", "canceled", "incomplete", "incomplete_expired", "past_due", "trialing", "unpaid"],
+ "enum": [
+ "active",
+ "canceled",
+ "incomplete",
+ "incomplete_expired",
+ "past_due",
+ "trialing",
+ "unpaid"
+ ],
"type": "string"
},
"tax_percent": {
@@ -16517,7 +16736,13 @@
],
"title": "SubscriptionSchedule",
"type": "object",
- "x-expandableFields": ["current_phase", "customer", "default_settings", "phases", "subscription"],
+ "x-expandableFields": [
+ "current_phase",
+ "customer",
+ "default_settings",
+ "phases",
+ "subscription"
+ ],
"x-resourceId": "subscription_schedule"
},
"subscription_schedule_configuration_item": {
@@ -16842,7 +17067,17 @@
},
"type": {
"description": "Type of the tax ID, one of `au_abn`, `ch_vat`, `eu_vat`, `in_gst`, `mx_rfc`, `no_vat`, `nz_gst`, `za_vat`, or `unknown`",
- "enum": ["au_abn", "ch_vat", "eu_vat", "in_gst", "mx_rfc", "no_vat", "nz_gst", "unknown", "za_vat"],
+ "enum": [
+ "au_abn",
+ "ch_vat",
+ "eu_vat",
+ "in_gst",
+ "mx_rfc",
+ "no_vat",
+ "nz_gst",
+ "unknown",
+ "za_vat"
+ ],
"type": "string"
},
"value": {
@@ -16854,7 +17089,16 @@
"$ref": "#/components/schemas/tax_id_verification"
}
},
- "required": ["created", "customer", "id", "livemode", "object", "type", "value", "verification"],
+ "required": [
+ "created",
+ "customer",
+ "id",
+ "livemode",
+ "object",
+ "type",
+ "value",
+ "verification"
+ ],
"title": "tax_id",
"type": "object",
"x-expandableFields": ["customer", "verification"],
@@ -17087,7 +17331,15 @@
"type": "string"
}
},
- "required": ["device_type", "id", "label", "livemode", "metadata", "object", "serial_number"],
+ "required": [
+ "device_type",
+ "id",
+ "label",
+ "livemode",
+ "metadata",
+ "object",
+ "serial_number"
+ ],
"title": "TerminalReaderReader",
"type": "object",
"x-expandableFields": [],
@@ -17141,7 +17393,17 @@
"type": "string"
}
},
- "required": ["amount", "authenticated", "card", "created", "currency", "id", "livemode", "object", "status"],
+ "required": [
+ "amount",
+ "authenticated",
+ "card",
+ "created",
+ "currency",
+ "id",
+ "livemode",
+ "object",
+ "status"
+ ],
"title": "ThreeDSecure",
"type": "object",
"x-expandableFields": ["card"],
@@ -17331,7 +17593,17 @@
"type": "string"
}
},
- "required": ["amount", "created", "currency", "id", "livemode", "metadata", "object", "source", "status"],
+ "required": [
+ "amount",
+ "created",
+ "currency",
+ "id",
+ "livemode",
+ "metadata",
+ "object",
+ "source",
+ "status"
+ ],
"title": "Topup",
"type": "object",
"x-expandableFields": ["balance_transaction", "source"],
@@ -17679,7 +17951,12 @@
"required": ["amount", "created", "currency", "id", "metadata", "object", "transfer"],
"title": "TransferReversal",
"type": "object",
- "x-expandableFields": ["balance_transaction", "destination_payment_refund", "source_refund", "transfer"],
+ "x-expandableFields": [
+ "balance_transaction",
+ "destination_payment_refund",
+ "source_refund",
+ "transfer"
+ ],
"x-resourceId": "transfer_reversal"
},
"transfer_schedule": {
@@ -18784,7 +19061,15 @@
"type": "integer"
},
"weekly_anchor": {
- "enum": ["friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday"],
+ "enum": [
+ "friday",
+ "monday",
+ "saturday",
+ "sunday",
+ "thursday",
+ "tuesday",
+ "wednesday"
+ ],
"maxLength": 5000,
"type": "string"
}
@@ -22892,7 +23177,15 @@
"type": "integer"
},
"weekly_anchor": {
- "enum": ["friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday"],
+ "enum": [
+ "friday",
+ "monday",
+ "saturday",
+ "sunday",
+ "thursday",
+ "tuesday",
+ "wednesday"
+ ],
"maxLength": 5000,
"type": "string"
}
@@ -23739,7 +24032,15 @@
"type": "integer"
},
"weekly_anchor": {
- "enum": ["friday", "monday", "saturday", "sunday", "thursday", "tuesday", "wednesday"],
+ "enum": [
+ "friday",
+ "monday",
+ "saturday",
+ "sunday",
+ "thursday",
+ "tuesday",
+ "wednesday"
+ ],
"maxLength": 5000,
"type": "string"
}
@@ -33087,7 +33388,16 @@
"items": {
"properties": {
"type": {
- "enum": ["au_abn", "ch_vat", "eu_vat", "in_gst", "mx_rfc", "no_vat", "nz_gst", "za_vat"],
+ "enum": [
+ "au_abn",
+ "ch_vat",
+ "eu_vat",
+ "in_gst",
+ "mx_rfc",
+ "no_vat",
+ "nz_gst",
+ "za_vat"
+ ],
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
@@ -37705,7 +38015,16 @@
},
"type": {
"description": "Type of the tax ID, one of `au_abn`, `ch_vat`, `eu_vat`, `in_gst`, `mx_rfc`, `no_vat`, `nz_gst`, or `za_vat`",
- "enum": ["au_abn", "ch_vat", "eu_vat", "in_gst", "mx_rfc", "no_vat", "nz_gst", "za_vat"],
+ "enum": [
+ "au_abn",
+ "ch_vat",
+ "eu_vat",
+ "in_gst",
+ "mx_rfc",
+ "no_vat",
+ "nz_gst",
+ "za_vat"
+ ],
"maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
@@ -44194,7 +44513,14 @@
"type": "array"
},
"interval": {
- "enum": ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"],
+ "enum": [
+ "all_time",
+ "daily",
+ "monthly",
+ "per_authorization",
+ "weekly",
+ "yearly"
+ ],
"type": "string"
}
},
@@ -45402,7 +45728,14 @@
"type": "array"
},
"interval": {
- "enum": ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"],
+ "enum": [
+ "all_time",
+ "daily",
+ "monthly",
+ "per_authorization",
+ "weekly",
+ "yearly"
+ ],
"type": "string"
}
},
@@ -46754,7 +47087,14 @@
"type": "array"
},
"interval": {
- "enum": ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"],
+ "enum": [
+ "all_time",
+ "daily",
+ "monthly",
+ "per_authorization",
+ "weekly",
+ "yearly"
+ ],
"type": "string"
}
},
@@ -47914,7 +48254,14 @@
"type": "array"
},
"interval": {
- "enum": ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"],
+ "enum": [
+ "all_time",
+ "daily",
+ "monthly",
+ "per_authorization",
+ "weekly",
+ "yearly"
+ ],
"type": "string"
}
},
diff --git a/packages/loaders/openapi/tests/fixtures/toto.yml b/packages/loaders/openapi/tests/fixtures/toto.yml
index 9dae159d7b2c6..6d589a1958533 100644
--- a/packages/loaders/openapi/tests/fixtures/toto.yml
+++ b/packages/loaders/openapi/tests/fixtures/toto.yml
@@ -607,7 +607,9 @@ components:
pattern: '^(FILE_TYPE|NAME|LAST_UPDATE_DATE)(,(ASC|DESC))?$'
targetAudience:
name: targetAudience
- description: Target of the resource (the resource need to have all of the target audience passed in the list)
+ description:
+ Target of the resource (the resource need to have all of the target audience passed in the
+ list)
in: query
required: false
schema:
diff --git a/packages/loaders/openapi/tests/fixtures/uk_teachers_training_courses.json b/packages/loaders/openapi/tests/fixtures/uk_teachers_training_courses.json
index 2e21324930224..56b1c6263975c 100644
--- a/packages/loaders/openapi/tests/fixtures/uk_teachers_training_courses.json
+++ b/packages/loaders/openapi/tests/fixtures/uk_teachers_training_courses.json
@@ -811,7 +811,11 @@
"vacancy_status": {
"type": "string",
"description": "What type of vacancies are available.",
- "enum": ["full_time_vacancies", "part_time_vacancies", "both_full_time_and_part_time_vacancies"],
+ "enum": [
+ "full_time_vacancies",
+ "part_time_vacancies",
+ "both_full_time_and_part_time_vacancies"
+ ],
"example": "full_time_vacancies"
}
}
diff --git a/packages/loaders/openapi/tests/fixtures/weather_underground.json b/packages/loaders/openapi/tests/fixtures/weather_underground.json
index 8db5272824055..315338c5fdd8c 100644
--- a/packages/loaders/openapi/tests/fixtures/weather_underground.json
+++ b/packages/loaders/openapi/tests/fixtures/weather_underground.json
@@ -260,7 +260,9 @@
"watchers": 1,
"forks": 1,
"subscribers": 1,
- "sources": ["https://github.com/dasmoose/tundra/blob/44bea73bb96d3501e8c3f97666d823041d48f348/lib/constants.rb"]
+ "sources": [
+ "https://github.com/dasmoose/tundra/blob/44bea73bb96d3501e8c3f97666d823041d48f348/lib/constants.rb"
+ ]
},
{
"repository": "fplatten/wuapi",
@@ -639,7 +641,16 @@
"type": "string"
}
},
- "required": ["full", "city", "state", "country", "country_iso3166", "latitude", "longitude", "elevation"]
+ "required": [
+ "full",
+ "city",
+ "state",
+ "country",
+ "country_iso3166",
+ "latitude",
+ "longitude",
+ "elevation"
+ ]
},
"estimated": {
"type": "object",
@@ -924,7 +935,15 @@
"type": "string"
}
},
- "required": ["period", "icon", "icon_url", "title", "fcttext", "fcttext_metric", "pop"]
+ "required": [
+ "period",
+ "icon",
+ "icon_url",
+ "title",
+ "fcttext",
+ "fcttext_metric",
+ "pop"
+ ]
}
}
},
diff --git a/packages/loaders/openapi/tests/nested_objects.test.ts b/packages/loaders/openapi/tests/nested_objects.test.ts
index 3b0c349a8724a..56e95ddedd291 100644
--- a/packages/loaders/openapi/tests/nested_objects.test.ts
+++ b/packages/loaders/openapi/tests/nested_objects.test.ts
@@ -40,7 +40,10 @@ describe('OpanAPI: nested objects', () => {
it('Get response', async () => {
const query = /* GraphQL */ `
{
- searchCollection(collectionName: "CHECKOUT_SUPER_PRODUCT", searchParameters: { q: "water", query_by: "name" }) {
+ searchCollection(
+ collectionName: "CHECKOUT_SUPER_PRODUCT"
+ searchParameters: { q: "water", query_by: "name" }
+ ) {
... on SearchResult {
hits {
document
diff --git a/packages/loaders/openapi/tests/query-params-with-post.test.ts b/packages/loaders/openapi/tests/query-params-with-post.test.ts
index b1033032865ad..c18a3737a575e 100644
--- a/packages/loaders/openapi/tests/query-params-with-post.test.ts
+++ b/packages/loaders/openapi/tests/query-params-with-post.test.ts
@@ -22,7 +22,7 @@ describe('Query Params with POST', () => {
headers: {
'Content-Type': 'application/json',
},
- }
+ },
);
},
cwd: __dirname,
diff --git a/packages/loaders/raml/README.md b/packages/loaders/raml/README.md
index 04192283bf496..5528c478d6e33 100644
--- a/packages/loaders/raml/README.md
+++ b/packages/loaders/raml/README.md
@@ -1,6 +1,8 @@
## RAML (@omnigraph/raml)
-This package generates `GraphQLSchema` instance from **RAML API Document** (`.raml`) file located at a URL or FileSystem by resolving the JSON Schema dependencies. It uses `@omnigraph/json-schema` by generating the necessary configuration.
+This package generates `GraphQLSchema` instance from **RAML API Document** (`.raml`) file located at
+a URL or FileSystem by resolving the JSON Schema dependencies. It uses `@omnigraph/json-schema` by
+generating the necessary configuration.
```yaml filename=".graphqlrc.yml"
schema:
diff --git a/packages/loaders/raml/src/bundle.ts b/packages/loaders/raml/src/bundle.ts
index 1ae35d78267b8..e4ebc9549dfec 100644
--- a/packages/loaders/raml/src/bundle.ts
+++ b/packages/loaders/raml/src/bundle.ts
@@ -10,11 +10,19 @@ import { RAMLLoaderOptions } from './types.js';
* Creates a bundle by downloading and resolving the internal references once
* to load the schema locally later
*/
-export async function createBundle(name: string, ramlLoaderOptions: RAMLLoaderOptions): Promise {
- const { operations, baseUrl, cwd, fetch } = await getJSONSchemaOptionsFromRAMLOptions(ramlLoaderOptions);
+export async function createBundle(
+ name: string,
+ ramlLoaderOptions: RAMLLoaderOptions,
+): Promise {
+ const { operations, baseUrl, cwd, fetch } = await getJSONSchemaOptionsFromRAMLOptions(
+ ramlLoaderOptions,
+ );
return createJSONSchemaLoaderBundle(name, {
...ramlLoaderOptions,
- operationHeaders: typeof ramlLoaderOptions.operationHeaders === 'object' ? ramlLoaderOptions.operationHeaders : {},
+ operationHeaders:
+ typeof ramlLoaderOptions.operationHeaders === 'object'
+ ? ramlLoaderOptions.operationHeaders
+ : {},
baseUrl,
operations,
cwd,
diff --git a/packages/loaders/raml/src/getJSONSchemaOptionsFromRAMLOptions.ts b/packages/loaders/raml/src/getJSONSchemaOptionsFromRAMLOptions.ts
index 315f92751b8ca..fc838f91d8b19 100644
--- a/packages/loaders/raml/src/getJSONSchemaOptionsFromRAMLOptions.ts
+++ b/packages/loaders/raml/src/getJSONSchemaOptionsFromRAMLOptions.ts
@@ -1,5 +1,9 @@
import { sanitizeNameForGraphQL } from '@graphql-mesh/utils';
-import { HTTPMethod, JSONSchemaOperationConfig, JSONSchemaOperationResponseConfig } from '@omnigraph/json-schema';
+import {
+ HTTPMethod,
+ JSONSchemaOperationConfig,
+ JSONSchemaOperationResponseConfig,
+} from '@omnigraph/json-schema';
import { getAbsolutePath, getCwd, JSONSchemaObject } from 'json-machete';
import { api10, loadApi } from '@ardatan/raml-1-parser';
import { fetch as crossUndiciFetch } from '@whatwg-node/fetch';
@@ -212,10 +216,15 @@ export async function getJSONSchemaOptionsFromRAMLOptions({
}
fieldName =
fieldName ||
- getFieldNameFromPath(originalFullRelativeUrl, method, responseByStatusCode['200']?.responseTypeName);
+ getFieldNameFromPath(
+ originalFullRelativeUrl,
+ method,
+ responseByStatusCode['200']?.responseTypeName,
+ );
if (fieldName) {
const graphQLFieldName = sanitizeNameForGraphQL(fieldName);
- const operationType: any = fieldTypeMap[graphQLFieldName] ?? method === 'GET' ? 'query' : 'mutation';
+ const operationType: any =
+ fieldTypeMap[graphQLFieldName] ?? method === 'GET' ? 'query' : 'mutation';
operations.push({
type: operationType,
field: graphQLFieldName,
diff --git a/packages/loaders/soap/src/SOAPLoader.ts b/packages/loaders/soap/src/SOAPLoader.ts
index 9b119c412d509..849443c8b7b06 100644
--- a/packages/loaders/soap/src/SOAPLoader.ts
+++ b/packages/loaders/soap/src/SOAPLoader.ts
@@ -69,7 +69,18 @@ const soapDirective = new GraphQLDirective({
},
});
-const QUERY_PREFIXES = ['get', 'find', 'list', 'search', 'count', 'exists', 'fetch', 'load', 'query', 'select'];
+const QUERY_PREFIXES = [
+ 'get',
+ 'find',
+ 'list',
+ 'search',
+ 'count',
+ 'exists',
+ 'fetch',
+ 'load',
+ 'query',
+ 'select',
+];
function isQueryOperationName(operationName: string) {
return QUERY_PREFIXES.some(prefix => operationName.toLowerCase().startsWith(prefix));
@@ -93,7 +104,11 @@ export class SOAPLoader {
>();
private complexTypeInputTCMap = new WeakMap();
- private complexTypeOutputTCMap = new WeakMap();
+ private complexTypeOutputTCMap = new WeakMap<
+ XSComplexType,
+ ObjectTypeComposer | ScalarTypeComposer
+ >();
+
private simpleTypeTCMap = new WeakMap();
private namespaceTypePrefixMap = new Map();
public loadedLocations = new Map();
@@ -208,7 +223,8 @@ export class SOAPLoader {
let typePrefix = this.namespaceTypePrefixMap.get(schemaNamespace);
if (!typePrefix) {
typePrefix =
- schemaObj.attributes.id || [...aliasMap.entries()].find(([, namespace]) => namespace === schemaNamespace)?.[0];
+ schemaObj.attributes.id ||
+ [...aliasMap.entries()].find(([, namespace]) => namespace === schemaNamespace)?.[0];
this.namespaceTypePrefixMap.set(schemaNamespace, typePrefix);
}
for (const [alias, namespace] of parentAliasMap) {
@@ -268,11 +284,17 @@ export class SOAPLoader {
}
const refComplexType = this.getNamespaceComplexTypeMap(refTypeNamespace).get(refTypeName);
if (refComplexType) {
- this.getNamespaceComplexTypeMap(schemaNamespace).set(elementObj.attributes.name, refComplexType);
+ this.getNamespaceComplexTypeMap(schemaNamespace).set(
+ elementObj.attributes.name,
+ refComplexType,
+ );
}
const refSimpleType = this.getNamespaceSimpleTypeMap(refTypeNamespace).get(refTypeName);
if (refSimpleType) {
- this.getNamespaceSimpleTypeMap(schemaNamespace).set(elementObj.attributes.name, refSimpleType);
+ this.getNamespaceSimpleTypeMap(schemaNamespace).set(
+ elementObj.attributes.name,
+ refSimpleType,
+ );
}
}
}
@@ -285,7 +307,9 @@ export class SOAPLoader {
const definitionNamespace = definition.attributes.targetNamespace;
const typePrefix =
definition.attributes.name ||
- [...definitionAliasMap.entries()].find(([, namespace]) => namespace === definitionNamespace)[0];
+ [...definitionAliasMap.entries()].find(
+ ([, namespace]) => namespace === definitionNamespace,
+ )[0];
this.namespaceTypePrefixMap.set(definition.attributes.targetNamespace, typePrefix);
if (definition.import) {
for (const importObj of definition.import) {
@@ -303,21 +327,27 @@ export class SOAPLoader {
}
}
if (definition.portType) {
- const namespacePortTypes = this.getNamespacePortTypeMap(definition.attributes.targetNamespace);
+ const namespacePortTypes = this.getNamespacePortTypeMap(
+ definition.attributes.targetNamespace,
+ );
for (const portTypeObj of definition.portType) {
namespacePortTypes.set(portTypeObj.attributes.name, portTypeObj);
this.aliasMap.set(portTypeObj, definitionAliasMap);
}
}
if (definition.binding) {
- const namespaceBindingMap = this.getNamespaceBindingMap(definition.attributes.targetNamespace);
+ const namespaceBindingMap = this.getNamespaceBindingMap(
+ definition.attributes.targetNamespace,
+ );
for (const bindingObj of definition.binding) {
namespaceBindingMap.set(bindingObj.attributes.name, bindingObj);
this.aliasMap.set(bindingObj, definitionAliasMap);
}
}
if (definition.message) {
- const namespaceMessageMap = this.getNamespaceMessageMap(definition.attributes.targetNamespace);
+ const namespaceMessageMap = this.getNamespaceMessageMap(
+ definition.attributes.targetNamespace,
+ );
for (const messageObj of definition.message) {
namespaceMessageMap.set(messageObj.attributes.name, messageObj);
this.aliasMap.set(messageObj, definitionAliasMap);
@@ -337,7 +367,7 @@ export class SOAPLoader {
const bindingObj = this.getNamespaceBindingMap(bindingNamespace).get(bindingName);
if (!bindingObj) {
throw new Error(
- `Binding: ${bindingName} is not defined in ${bindingNamespace} needed for ${serviceName}->${portName}`
+ `Binding: ${bindingName} is not defined in ${bindingNamespace} needed for ${serviceName}->${portName}`,
);
}
const bindingAliasMap = this.aliasMap.get(bindingObj);
@@ -352,7 +382,7 @@ export class SOAPLoader {
const portTypeObj = this.getNamespacePortTypeMap(portTypeNamespace).get(portTypeName);
if (!portTypeObj) {
throw new Error(
- `Port Type: ${portTypeName} is not defined in ${portTypeNamespace} needed for ${bindingNamespaceAlias}->${bindingName}`
+ `Port Type: ${portTypeName} is not defined in ${portTypeNamespace} needed for ${bindingNamespaceAlias}->${bindingName}`,
);
}
const portTypeAliasMap = this.aliasMap.get(portTypeObj);
@@ -362,7 +392,7 @@ export class SOAPLoader {
? this.schemaComposer.Query
: this.schemaComposer.Mutation;
const operationFieldName = sanitizeNameForGraphQL(
- `${typePrefix}_${serviceName}_${portName}_${operationName}`
+ `${typePrefix}_${serviceName}_${portName}_${operationName}`,
);
const outputObj = operationObj.output[0];
const [messageNamespaceAlias, messageName] = outputObj.attributes.message.split(':');
@@ -371,7 +401,7 @@ export class SOAPLoader {
throw new Error(`Namespace alias: ${messageNamespaceAlias} is undefined!`);
}
const { type, elementName } = this.getOutputTypeForMessage(
- this.getNamespaceMessageMap(messageNamespace).get(messageName)
+ this.getNamespaceMessageMap(messageNamespace).get(messageName),
);
const soapAnnotations: SoapAnnotations = {
elementName,
@@ -390,15 +420,17 @@ export class SOAPLoader {
},
});
const inputObj = operationObj.input[0];
- const [inputMessageNamespaceAlias, inputMessageName] = inputObj.attributes.message.split(':');
+ const [inputMessageNamespaceAlias, inputMessageName] =
+ inputObj.attributes.message.split(':');
const inputMessageNamespace = portTypeAliasMap.get(inputMessageNamespaceAlias);
if (!inputMessageNamespace) {
throw new Error(`Namespace alias: ${inputMessageNamespaceAlias} is undefined!`);
}
- const inputMessageObj = this.getNamespaceMessageMap(inputMessageNamespace).get(inputMessageName);
+ const inputMessageObj =
+ this.getNamespaceMessageMap(inputMessageNamespace).get(inputMessageName);
if (!inputMessageObj) {
throw new Error(
- `Message: ${inputMessageName} is not defined in ${inputMessageNamespace} needed for ${portTypeName}->${operationName}`
+ `Message: ${inputMessageName} is not defined in ${inputMessageNamespace} needed for ${portTypeName}->${operationName}`,
);
}
const aliasMap = this.aliasMap.get(inputMessageObj);
@@ -409,9 +441,12 @@ export class SOAPLoader {
[elementName]: {
type: () => {
const elementNamespace =
- aliasMap.get(elementNamespaceAlias) || part.attributes[elementNamespaceAlias];
+ aliasMap.get(elementNamespaceAlias) ||
+ part.attributes[elementNamespaceAlias];
if (!elementNamespace) {
- throw new Error(`Namespace alias: ${elementNamespaceAlias} is not defined.`);
+ throw new Error(
+ `Namespace alias: ${elementNamespaceAlias} is not defined.`,
+ );
}
return this.getInputTypeForTypeNameInNamespace({
typeName: elementName,
@@ -432,7 +467,10 @@ export class SOAPLoader {
if (!typeNamespace) {
throw new Error(`Namespace alias: ${typeNamespaceAlias} is undefined!`);
}
- const inputTC = this.getInputTypeForTypeNameInNamespace({ typeName, typeNamespace });
+ const inputTC = this.getInputTypeForTypeNameInNamespace({
+ typeName,
+ typeNamespace,
+ });
if ('getFields' in inputTC && Object.keys(inputTC.getFields()).length === 0) {
return GraphQLJSON;
}
@@ -488,7 +526,10 @@ export class SOAPLoader {
return aliasMap;
}
- getTypeForSimpleType(simpleType: XSSimpleType, simpleTypeNamespace: string): EnumTypeComposer | ScalarTypeComposer {
+ getTypeForSimpleType(
+ simpleType: XSSimpleType,
+ simpleTypeNamespace: string,
+ ): EnumTypeComposer | ScalarTypeComposer {
let simpleTypeTC = this.simpleTypeTCMap.get(simpleType);
if (!simpleTypeTC) {
const simpleTypeName = simpleType.attributes.name;
@@ -512,7 +553,9 @@ export class SOAPLoader {
const patternObj = restrictionObj.pattern[0];
const pattern = patternObj.attributes.value;
const scalarTypeName = `${prefix}_${simpleTypeName}`;
- simpleTypeTC = this.schemaComposer.createScalarTC(new RegularExpression(scalarTypeName, new RegExp(pattern)));
+ simpleTypeTC = this.schemaComposer.createScalarTC(
+ new RegularExpression(scalarTypeName, new RegExp(pattern)),
+ );
} else {
// TODO: Other restrictions are not supported yet
const aliasMap = this.aliasMap.get(simpleType);
@@ -524,7 +567,7 @@ export class SOAPLoader {
const baseType = this.getNamespaceSimpleTypeMap(baseTypeNamespace)?.get(baseTypeName);
if (!baseType) {
throw new Error(
- `Simple Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${simpleTypeName}`
+ `Simple Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${simpleTypeName}`,
);
}
simpleTypeTC = this.getTypeForSimpleType(baseType, baseTypeNamespace);
@@ -534,7 +577,13 @@ export class SOAPLoader {
return simpleTypeTC;
}
- getInputTypeForTypeNameInNamespace({ typeName, typeNamespace }: { typeName: string; typeNamespace: string }) {
+ getInputTypeForTypeNameInNamespace({
+ typeName,
+ typeNamespace,
+ }: {
+ typeName: string;
+ typeNamespace: string;
+ }) {
const complexType = this.getNamespaceComplexTypeMap(typeNamespace)?.get(typeName);
if (complexType) {
return this.getInputTypeForComplexType(complexType, typeNamespace);
@@ -553,7 +602,10 @@ export class SOAPLoader {
const prefix = this.namespaceTypePrefixMap.get(complexTypeNamespace);
const aliasMap = this.aliasMap.get(complexType);
const fieldMap: InputTypeComposerFieldConfigMapDefinition = {};
- const choiceOrSequenceObjects = [...(complexType.sequence || []), ...(complexType.choice || [])];
+ const choiceOrSequenceObjects = [
+ ...(complexType.sequence || []),
+ ...(complexType.choice || []),
+ ];
for (const sequenceOrChoiceObj of choiceOrSequenceObjects) {
if (sequenceOrChoiceObj.element) {
for (const elementObj of sequenceOrChoiceObj.element) {
@@ -561,9 +613,12 @@ export class SOAPLoader {
if (fieldName) {
fieldMap[fieldName] = {
type: () => {
- const maxOccurs = sequenceOrChoiceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
- const minOccurs = sequenceOrChoiceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
- const nillable = sequenceOrChoiceObj.attributes?.nillable || elementObj.attributes?.nillable;
+ const maxOccurs =
+ sequenceOrChoiceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
+ const minOccurs =
+ sequenceOrChoiceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
+ const nillable =
+ sequenceOrChoiceObj.attributes?.nillable || elementObj.attributes?.nillable;
const isPlural = maxOccurs != null && maxOccurs !== '1';
let isNullable = false;
if (minOccurs == null || minOccurs === '0') {
@@ -605,10 +660,11 @@ export class SOAPLoader {
this.aliasMap.set(simpleTypeObj, aliasMap);
// Inherit the name from elementObj
simpleTypeObj.attributes = simpleTypeObj.attributes || ({} as any);
- simpleTypeObj.attributes.name = simpleTypeObj.attributes.name || elementObj.attributes.name;
+ simpleTypeObj.attributes.name =
+ simpleTypeObj.attributes.name || elementObj.attributes.name;
let finalTC: AnyTypeComposer = this.getTypeForSimpleType(
simpleTypeObj,
- complexTypeNamespace
+ complexTypeNamespace,
);
if (isPlural) {
finalTC = finalTC.getTypePlural();
@@ -626,10 +682,11 @@ export class SOAPLoader {
this.aliasMap.set(complexTypeObj, aliasMap);
// Inherit the name from elementObj
complexTypeObj.attributes = complexTypeObj.attributes || ({} as any);
- complexTypeObj.attributes.name = complexTypeObj.attributes.name || elementObj.attributes.name;
+ complexTypeObj.attributes.name =
+ complexTypeObj.attributes.name || elementObj.attributes.name;
let finalTC: AnyTypeComposer = this.getInputTypeForComplexType(
complexTypeObj,
- complexTypeNamespace
+ complexTypeNamespace,
);
if (isPlural) {
finalTC = finalTC.getTypePlural();
@@ -640,7 +697,9 @@ export class SOAPLoader {
return finalTC;
}
}
- throw new Error(`Invalid element type definition: ${complexTypeName}->${fieldName}`);
+ throw new Error(
+ `Invalid element type definition: ${complexTypeName}->${fieldName}`,
+ );
},
};
} else {
@@ -685,7 +744,7 @@ export class SOAPLoader {
const baseType = this.getNamespaceComplexTypeMap(baseTypeNamespace)?.get(baseTypeName);
if (!baseType) {
throw new Error(
- `Complex Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${complexTypeName}`
+ `Complex Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${complexTypeName}`,
);
}
const baseTypeTC = this.getInputTypeForComplexType(baseType, baseTypeNamespace);
@@ -727,7 +786,11 @@ export class SOAPLoader {
return complexTypeTC;
}
- getOutputFieldTypeFromElement(elementObj: XSElement, aliasMap: Map, namespace: string) {
+ getOutputFieldTypeFromElement(
+ elementObj: XSElement,
+ aliasMap: Map,
+ namespace: string,
+ ) {
if (elementObj.attributes?.type) {
const [typeNamespaceAlias, typeName] = elementObj.attributes.type.split(':');
let typeNamespace: string;
@@ -761,7 +824,8 @@ export class SOAPLoader {
this.aliasMap.set(complexTypeObj, aliasMap);
// Inherit the name from elementObj
complexTypeObj.attributes = complexTypeObj.attributes || ({} as any);
- complexTypeObj.attributes.name = complexTypeObj.attributes.name || elementObj.attributes.name;
+ complexTypeObj.attributes.name =
+ complexTypeObj.attributes.name || elementObj.attributes.name;
const outputTC = this.getOutputTypeForComplexType(complexTypeObj, namespace);
return outputTC;
}
@@ -776,15 +840,21 @@ export class SOAPLoader {
const prefix = this.namespaceTypePrefixMap.get(complexTypeNamespace);
const aliasMap = this.aliasMap.get(complexType);
const fieldMap: Record> = {};
- const choiceOrSequenceObjects = [...(complexType.sequence || []), ...(complexType.choice || [])];
+ const choiceOrSequenceObjects = [
+ ...(complexType.sequence || []),
+ ...(complexType.choice || []),
+ ];
for (const choiceOrSequenceObj of choiceOrSequenceObjects) {
if (choiceOrSequenceObj.element) {
for (const elementObj of choiceOrSequenceObj.element) {
const fieldName = elementObj.attributes.name;
if (fieldName) {
- const maxOccurs = choiceOrSequenceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
- const minOccurs = choiceOrSequenceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
- const nillable = choiceOrSequenceObj.attributes?.nillable || elementObj.attributes?.nillable;
+ const maxOccurs =
+ choiceOrSequenceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
+ const minOccurs =
+ choiceOrSequenceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
+ const nillable =
+ choiceOrSequenceObj.attributes?.nillable || elementObj.attributes?.nillable;
const isPlural = maxOccurs != null && maxOccurs !== '1';
let isNullable = false;
if (minOccurs == null || minOccurs === '0') {
@@ -801,7 +871,7 @@ export class SOAPLoader {
let outputTC: AnyTypeComposer = this.getOutputFieldTypeFromElement(
elementObj,
aliasMap,
- complexTypeNamespace
+ complexTypeNamespace,
);
if (isPlural) {
outputTC = outputTC.getTypePlural();
@@ -843,14 +913,15 @@ export class SOAPLoader {
for (const extensionObj of complexContentObj.extension) {
const [baseTypeNamespaceAlias, baseTypeName] = extensionObj.attributes.base.split(':');
const baseTypeNamespace =
- aliasMap.get(baseTypeNamespaceAlias) || extensionObj.attributes[baseTypeNamespaceAlias];
+ aliasMap.get(baseTypeNamespaceAlias) ||
+ extensionObj.attributes[baseTypeNamespaceAlias];
if (!baseTypeNamespace) {
throw new Error(`Namespace alias: ${baseTypeNamespaceAlias} is undefined!`);
}
const baseType = this.getNamespaceComplexTypeMap(baseTypeNamespace)?.get(baseTypeName);
if (!baseType) {
throw new Error(
- `Complex Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${complexTypeName}`
+ `Complex Type: ${baseTypeName} couldn't be found in ${baseTypeNamespace} needed for ${complexTypeName}`,
);
}
const baseTypeTC = this.getOutputTypeForComplexType(baseType, baseTypeNamespace);
@@ -859,13 +930,19 @@ export class SOAPLoader {
fieldMap[fieldName] = baseTypeTC.getField(fieldName);
}
}
- const choiceOrSequenceObjects = [...(extensionObj.sequence || []), ...(extensionObj.choice || [])];
+ const choiceOrSequenceObjects = [
+ ...(extensionObj.sequence || []),
+ ...(extensionObj.choice || []),
+ ];
for (const choiceOrSequenceObj of choiceOrSequenceObjects) {
for (const elementObj of choiceOrSequenceObj.element) {
const fieldName = elementObj.attributes.name;
- const maxOccurs = choiceOrSequenceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
- const minOccurs = choiceOrSequenceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
- const nillable = choiceOrSequenceObj.attributes?.nillable || elementObj.attributes?.nillable;
+ const maxOccurs =
+ choiceOrSequenceObj.attributes?.maxOccurs || elementObj.attributes?.maxOccurs;
+ const minOccurs =
+ choiceOrSequenceObj.attributes?.minOccurs || elementObj.attributes?.minOccurs;
+ const nillable =
+ choiceOrSequenceObj.attributes?.nillable || elementObj.attributes?.nillable;
const isPlural = maxOccurs != null && maxOccurs !== '1';
let isNullable = false;
if (minOccurs == null || minOccurs === '0') {
@@ -882,7 +959,7 @@ export class SOAPLoader {
let outputTC: AnyTypeComposer = this.getOutputFieldTypeFromElement(
elementObj,
aliasMap,
- complexTypeNamespace
+ complexTypeNamespace,
);
if (isPlural) {
outputTC = outputTC.getTypePlural();
@@ -911,7 +988,13 @@ export class SOAPLoader {
return complexTypeTC;
}
- getOutputTypeForTypeNameInNamespace({ typeName, typeNamespace }: { typeName: string; typeNamespace: string }) {
+ getOutputTypeForTypeNameInNamespace({
+ typeName,
+ typeNamespace,
+ }: {
+ typeName: string;
+ typeNamespace: string;
+ }) {
const complexType = this.getNamespaceComplexTypeMap(typeNamespace)?.get(typeName);
if (complexType) {
return this.getOutputTypeForComplexType(complexType, typeNamespace);
diff --git a/packages/loaders/soap/src/executor.ts b/packages/loaders/soap/src/executor.ts
index 3218cafb39070..3061600ecb6b9 100644
--- a/packages/loaders/soap/src/executor.ts
+++ b/packages/loaders/soap/src/executor.ts
@@ -19,7 +19,12 @@ function isOriginallyListType(type: GraphQLOutputType): boolean {
return isListType(type);
}
-const defaultFieldResolver: GraphQLFieldResolver = function soapDefaultResolver(root, args, context, info) {
+const defaultFieldResolver: GraphQLFieldResolver = function soapDefaultResolver(
+ root,
+ args,
+ context,
+ info,
+) {
const rootField = root[info.fieldName];
if (typeof rootField === 'function') {
return rootField(args, context, info);
@@ -68,7 +73,10 @@ function normalizeResult(result: any) {
type RootValueMethod = (args: any, context: any, info: GraphQLResolveInfo) => Promise;
-function createRootValueMethod(soapAnnotations: SoapAnnotations, fetchFn: MeshFetch): RootValueMethod {
+function createRootValueMethod(
+ soapAnnotations: SoapAnnotations,
+ fetchFn: MeshFetch,
+): RootValueMethod {
const jsonToXMLConverter = new JSONToXMLConverter({
attributeNamePrefix: '',
attrNodeName: 'attributes',
@@ -100,7 +108,7 @@ function createRootValueMethod(soapAnnotations: SoapAnnotations, fetchFn: MeshFe
},
},
context,
- info
+ info,
);
const responseXML = await response.text();
const responseJSON = parseXML(responseXML, PARSE_XML_OPTIONS);
diff --git a/packages/loaders/soap/test/examples.test.ts b/packages/loaders/soap/test/examples.test.ts
index fb58e415ea4fa..becfa933dadff 100644
--- a/packages/loaders/soap/test/examples.test.ts
+++ b/packages/loaders/soap/test/examples.test.ts
@@ -15,7 +15,10 @@ describe('Examples', () => {
const soapLoader = new SOAPLoader({
fetch,
});
- const example1Wsdl = await readFile(join(__dirname, './fixtures/' + example + '.wsdl'), 'utf8');
+ const example1Wsdl = await readFile(
+ join(__dirname, './fixtures/' + example + '.wsdl'),
+ 'utf8',
+ );
await soapLoader.loadWSDL(example1Wsdl);
const schema = soapLoader.buildSchema();
expect(printSchema(schema)).toMatchSnapshot(example);
diff --git a/packages/mergers/bare/src/index.ts b/packages/mergers/bare/src/index.ts
index 4ec938bf3c438..42a73734580ba 100644
--- a/packages/mergers/bare/src/index.ts
+++ b/packages/mergers/bare/src/index.ts
@@ -1,4 +1,9 @@
-import { MeshMerger, MeshMergerContext, MeshMergerOptions, RawSourceOutput } from '@graphql-mesh/types';
+import {
+ MeshMerger,
+ MeshMergerContext,
+ MeshMergerOptions,
+ RawSourceOutput,
+} from '@graphql-mesh/types';
import { applySchemaTransforms } from '@graphql-mesh/utils';
import { addResolversToSchema, mergeSchemas } from '@graphql-tools/schema';
import { asArray, mapSchema } from '@graphql-tools/utils';
@@ -13,7 +18,9 @@ export default class BareMerger implements MeshMerger {
handleSingleWrappedExtendedSource(mergerCtx: MeshMergerContext) {
// switch to stitching merger
this.name = 'stitching';
- this.options.logger.debug(`Switching to Stitching merger due to the transforms and additional resolvers`);
+ this.options.logger.debug(
+ `Switching to Stitching merger due to the transforms and additional resolvers`,
+ );
this.options.logger = this.options.logger.child('Stitching Proxy');
this.stitchingMerger = this.stitchingMerger || new StitchingMerger(this.options);
return this.stitchingMerger.getUnifiedSchema(mergerCtx);
@@ -42,7 +49,12 @@ export default class BareMerger implements MeshMerger {
// We should return a version of the schema only with the source-level transforms
// But we should prevent the existing schema from being mutated internally
const nonExecutableSchema = mapSchema(schema);
- return applySchemaTransforms(nonExecutableSchema, rawSource, nonExecutableSchema, rawSource.transforms);
+ return applySchemaTransforms(
+ nonExecutableSchema,
+ rawSource,
+ nonExecutableSchema,
+ rawSource.transforms,
+ );
},
};
},
diff --git a/packages/mergers/federation/src/index.ts b/packages/mergers/federation/src/index.ts
index 958a0d7832555..ddbe406e2f2cb 100644
--- a/packages/mergers/federation/src/index.ts
+++ b/packages/mergers/federation/src/index.ts
@@ -7,12 +7,24 @@ import {
MeshPubSub,
RawSourceOutput,
} from '@graphql-mesh/types';
-import { GraphQLSchema, extendSchema, DocumentNode, parse, execute, ExecutionResult } from 'graphql';
+import {
+ GraphQLSchema,
+ extendSchema,
+ DocumentNode,
+ parse,
+ execute,
+ ExecutionResult,
+} from 'graphql';
import { wrapSchema } from '@graphql-tools/wrap';
import { ApolloGateway, LocalGraphQLDataSource, SERVICE_DEFINITION_QUERY } from '@apollo/gateway';
import { addResolversToSchema } from '@graphql-tools/schema';
import { printWithCache } from '@graphql-mesh/utils';
-import { AggregateError, asArray, ExecutionRequest, printSchemaWithDirectives } from '@graphql-tools/utils';
+import {
+ AggregateError,
+ asArray,
+ ExecutionRequest,
+ printSchemaWithDirectives,
+} from '@graphql-tools/utils';
import { MeshStore, PredefinedProxyOptions } from '@graphql-mesh/store';
import { process } from '@graphql-mesh/cross-helpers';
@@ -48,7 +60,10 @@ export default class FederationMerger implements MeshMerger {
document: parse(SERVICE_DEFINITION_QUERY),
});
if (sdlQueryResult.errors?.length) {
- throw new AggregateError(sdlQueryResult.errors, `Failed on fetching Federated SDL for ${rawSource.name}`);
+ throw new AggregateError(
+ sdlQueryResult.errors,
+ `Failed on fetching Federated SDL for ${rawSource.name}`,
+ );
}
return sdlQueryResult.data._service.sdl;
});
@@ -56,7 +71,7 @@ export default class FederationMerger implements MeshMerger {
name: rawSource.name,
typeDefs: parse(sdl),
});
- })
+ }),
);
this.logger.debug(`Creating ApolloGateway`);
const gateway = new ApolloGateway({
@@ -76,7 +91,13 @@ export default class FederationMerger implements MeshMerger {
const schemaHash: any = printSchemaWithDirectives(schema);
let remoteSchema: GraphQLSchema = schema;
this.logger.debug(`Wrapping gateway executor in a unified schema`);
- const executor = ({ document, info, variables, context, operationName }: ExecutionRequest) => {
+ const executor = ({
+ document,
+ info,
+ variables,
+ context,
+ operationName,
+ }: ExecutionRequest) => {
const documentStr = printWithCache(document);
const { operation } = info;
// const operationName = operation.name?.value;
diff --git a/packages/mergers/stitching/src/index.ts b/packages/mergers/stitching/src/index.ts
index 61b2ba8cf5b69..a664da5791bae 100644
--- a/packages/mergers/stitching/src/index.ts
+++ b/packages/mergers/stitching/src/index.ts
@@ -1,4 +1,10 @@
-import { Logger, MeshMerger, MeshMergerContext, MeshMergerOptions, RawSourceOutput } from '@graphql-mesh/types';
+import {
+ Logger,
+ MeshMerger,
+ MeshMergerContext,
+ MeshMergerOptions,
+ RawSourceOutput,
+} from '@graphql-mesh/types';
import { stitchSchemas, ValidationLevel } from '@graphql-tools/stitch';
import { extractResolvers } from '@graphql-mesh/utils';
import { StitchingInfo } from '@graphql-tools/delegate';
@@ -42,7 +48,7 @@ export default class StitchingMerger implements MeshMerger {
name: string,
oldSchema: GraphQLSchema,
executor: Executor,
- stitchingDirectives: StitchingDirectivesResult
+ stitchingDirectives: StitchingDirectivesResult,
) {
const rawSourceLogger = this.logger.child(name);
@@ -61,7 +67,10 @@ export default class StitchingMerger implements MeshMerger {
document: parse(APOLLO_GET_SERVICE_DEFINITION_QUERY),
})) as ExecutionResult;
if (sdlQueryResult.errors?.length) {
- throw new AggregateError(sdlQueryResult.errors, `Failed on fetching Federated SDL for ${name}`);
+ throw new AggregateError(
+ sdlQueryResult.errors,
+ `Failed on fetching Federated SDL for ${name}`,
+ );
}
federationSdl = sdlQueryResult.data._service.sdl;
}
@@ -106,12 +115,13 @@ export default class StitchingMerger implements MeshMerger {
rawSource.name,
rawSource.schema,
rawSource.executor,
- defaultStitchingDirectives
+ defaultStitchingDirectives,
);
}
- rawSource.merge = defaultStitchingDirectives.stitchingDirectivesTransformer(rawSource).merge;
+ rawSource.merge =
+ defaultStitchingDirectives.stitchingDirectivesTransformer(rawSource).merge;
return rawSource;
- })
+ }),
);
this.logger.debug(`Stitching the source schemas`);
const unifiedSchema = stitchSchemas({
diff --git a/packages/plugins/deduplicate-request/tests/useDeduplicateRequest.test.ts b/packages/plugins/deduplicate-request/tests/useDeduplicateRequest.test.ts
index 213806fb3d9a4..59604967c3fc7 100644
--- a/packages/plugins/deduplicate-request/tests/useDeduplicateRequest.test.ts
+++ b/packages/plugins/deduplicate-request/tests/useDeduplicateRequest.test.ts
@@ -21,7 +21,7 @@ describe('useDeduplicateRequest', () => {
data: {
hello: 'world',
},
- })
+ }),
);
});
server.listen(9856, done);
@@ -53,7 +53,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
);
await response.text();
const response2 = await fetchFn(
@@ -63,7 +63,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
);
await response2.text();
expect(reqCount).toBe(1);
@@ -87,7 +87,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
),
fetchFn(
url,
@@ -96,7 +96,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
),
]);
await Promise.all([response.text(), response2.text()]);
@@ -120,7 +120,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
);
await response.text();
const response2 = await fetchFn(
@@ -130,7 +130,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
);
await response2.text();
expect(reqCount).toBe(2);
@@ -154,7 +154,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
),
fetchFn(
url + '2',
@@ -163,7 +163,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
),
]);
await Promise.all([response.text(), response2.text()]);
@@ -188,7 +188,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
);
await response.text();
const response2 = await fetchFn(
@@ -198,7 +198,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context2
+ context2,
);
await response2.text();
expect(reqCount).toBe(2);
@@ -223,7 +223,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context
+ context,
),
fetchFn(
url,
@@ -232,7 +232,7 @@ describe('useDeduplicateRequest', () => {
Accept: 'application/json',
},
},
- context2
+ context2,
),
]);
await Promise.all([response.text(), response2.text()]);
diff --git a/packages/plugins/hive/src/index.ts b/packages/plugins/hive/src/index.ts
index 1a32490f73ef4..6d263d98f5a16 100644
--- a/packages/plugins/hive/src/index.ts
+++ b/packages/plugins/hive/src/index.ts
@@ -3,7 +3,9 @@ import { MeshPlugin, MeshPluginOptions, YamlConfig } from '@graphql-mesh/types';
import { process } from '@graphql-mesh/cross-helpers';
import { stringInterpolator } from '@graphql-mesh/string-interpolation';
-export default function useMeshHive(pluginOptions: MeshPluginOptions): MeshPlugin<{}> {
+export default function useMeshHive(
+ pluginOptions: MeshPluginOptions,
+): MeshPlugin<{}> {
const token = stringInterpolator.parse(pluginOptions.token, {
env: process.env,
});
diff --git a/packages/plugins/http-cache/src/index.ts b/packages/plugins/http-cache/src/index.ts
index af9cab9845da0..40a423418b52f 100644
--- a/packages/plugins/http-cache/src/index.ts
+++ b/packages/plugins/http-cache/src/index.ts
@@ -73,13 +73,16 @@ export default function useHTTPCache({ cache }: MeshPluginOptions<{}>): MeshPlug
},
},
context,
- info
+ info,
);
- const { policy: revalidatedPolicy, modified } = policy.revalidatedPolicy(revalidationRequest, {
- status: revalidationResponse.status,
- headers: getHeadersObj(revalidationResponse.headers as any),
- });
+ const { policy: revalidatedPolicy, modified } = policy.revalidatedPolicy(
+ revalidationRequest,
+ {
+ status: revalidationResponse.status,
+ headers: getHeadersObj(revalidationResponse.headers as any),
+ },
+ );
const newBody = await revalidationResponse.text();
@@ -134,7 +137,7 @@ export default function useHTTPCache({ cache }: MeshPluginOptions<{}>): MeshPlug
new Response(resText, {
status: response.status,
headers: resHeaders,
- })
+ }),
);
}
}
diff --git a/packages/plugins/http-details-extensions/src/index.ts b/packages/plugins/http-details-extensions/src/index.ts
index b9d2051c3fc31..2e35e03134dbc 100644
--- a/packages/plugins/http-details-extensions/src/index.ts
+++ b/packages/plugins/http-details-extensions/src/index.ts
@@ -20,7 +20,9 @@ export interface MeshFetchHTTPInformation {
responseTime: number;
}
-export default function useIncludeHttpDetailsInExtensions(opts: MeshPluginOptions<{ if: any }>): MeshPlugin {
+export default function useIncludeHttpDetailsInExtensions(
+ opts: MeshPluginOptions<{ if: any }>,
+): MeshPlugin {
if ('if' in opts && !opts.if) {
return {};
}
diff --git a/packages/plugins/live-query/src/index.ts b/packages/plugins/live-query/src/index.ts
index a8c510a2c45db..b8a9d41d126a4 100644
--- a/packages/plugins/live-query/src/index.ts
+++ b/packages/plugins/live-query/src/index.ts
@@ -1,12 +1,17 @@
import { useLiveQuery } from '@envelop/live-query';
import { MeshPluginOptions, YamlConfig } from '@graphql-mesh/types';
-import { defaultResourceIdentifierNormalizer, InMemoryLiveQueryStore } from '@n1ru4l/in-memory-live-query-store';
+import {
+ defaultResourceIdentifierNormalizer,
+ InMemoryLiveQueryStore,
+} from '@n1ru4l/in-memory-live-query-store';
import { Plugin } from '@envelop/core';
import { useInvalidateByResult } from './useInvalidateByResult.js';
import { process } from '@graphql-mesh/cross-helpers';
import { stringInterpolator } from '@graphql-mesh/string-interpolation';
-export default function useMeshLiveQuery(options: MeshPluginOptions): Plugin {
+export default function useMeshLiveQuery(
+ options: MeshPluginOptions,
+): Plugin {
options.logger.debug(`Creating Live Query Store`);
const liveQueryStore = new InMemoryLiveQueryStore({
buildResourceIdentifier:
@@ -20,12 +25,14 @@ export default function useMeshLiveQuery(options: MeshPluginOptions
- liveQueryStore.invalidate(identifiers)
+ liveQueryStore.invalidate(identifiers),
);
return {
onPluginInit({ addPlugin }) {
@@ -36,7 +43,7 @@ export default function useMeshLiveQuery(options: MeshPluginOptions {
const rawInvalidationPaths = liveQueryInvalidation.invalidate;
const factories = rawInvalidationPaths.map(rawInvalidationPath =>
- getInterpolatedStringFactory(rawInvalidationPath)
+ getInterpolatedStringFactory(rawInvalidationPath),
);
liveQueryInvalidationFactoryMap.set(liveQueryInvalidation.field, factories);
});
@@ -22,7 +25,8 @@ export function useInvalidateByResult(params: InvalidateByResultParams): Plugin
onExecute() {
return {
onExecuteDone({ args: executionArgs, result }) {
- const { schema, document, operationName, variableValues, rootValue, contextValue } = executionArgs;
+ const { schema, document, operationName, variableValues, rootValue, contextValue } =
+ executionArgs;
const operationAST = getOperationAST(document, operationName);
if (!operationAST) {
throw new Error(`Operation couldn't be found`);
@@ -45,12 +49,12 @@ export function useInvalidateByResult(params: InvalidateByResultParams): Plugin
context: contextValue,
env: process.env,
result,
- })
+ }),
);
params.pubsub.publish('live-query:invalidate', invalidationPaths);
}
},
- })
+ }),
);
},
};
diff --git a/packages/plugins/mock/src/index.ts b/packages/plugins/mock/src/index.ts
index 39e8ffb6593e0..3e6d444f5d8d4 100644
--- a/packages/plugins/mock/src/index.ts
+++ b/packages/plugins/mock/src/index.ts
@@ -8,8 +8,10 @@ import { GraphQLResolveInfo, GraphQLFieldResolver, GraphQLSchema, execute } from
const mockedSchemas = new WeakSet();
-// eslint-disable-next-line @typescript-eslint/ban-types
-export default function useMock(config: MeshPluginOptions): MeshPlugin<{}> {
+export default function useMock(
+ config: MeshPluginOptions,
+ // eslint-disable-next-line @typescript-eslint/ban-types
+): MeshPlugin<{}> {
const configIf = config != null && 'if' in config ? config.if : true;
if (configIf) {
@@ -53,38 +55,66 @@ export default function useMock(config: MeshPluginOptions {
+ resolvers[typeName][fieldName] = (
+ root: any,
+ args: any,
+ context: any,
+ info: GraphQLResolveInfo,
+ ) => {
context = context || {};
context.mockStore = store;
return exportedVal$.then(exportedVal =>
- typeof exportedVal === 'function' ? exportedVal(root, args, context, info) : exportedVal
+ typeof exportedVal === 'function'
+ ? exportedVal(root, args, context, info)
+ : exportedVal,
);
};
} else if ('length' in fieldConfig) {
resolvers[typeName] = resolvers[typeName] || {};
resolvers[typeName][fieldName] = () => new Array(fieldConfig.length).fill({});
} else if ('updateStore' in fieldConfig) {
- const getFromStoreKeyFactory = getInterpolatedStringFactory(fieldConfig.store.key);
+ const getFromStoreKeyFactory = getInterpolatedStringFactory(
+ fieldConfig.store.key,
+ );
const updateStoreFactories = fieldConfig.updateStore.map(updateStoreConfig => ({
updateStoreConfig,
keyFactory: getInterpolatedStringFactory(updateStoreConfig.key),
valueFactory: getInterpolatedStringFactory(updateStoreConfig.value),
}));
resolvers[typeName] = resolvers[typeName] || {};
- resolvers[typeName][fieldName] = (root: any, args: any, context: any, info: GraphQLResolveInfo) => {
- const resolverData = { root, args, context, info, random: Date.now().toString(), env: process.env };
- updateStoreFactories.forEach(({ updateStoreConfig, keyFactory, valueFactory }) => {
- const key = keyFactory(resolverData);
- const value = valueFactory(resolverData);
- store.set(updateStoreConfig.type, key, updateStoreConfig.fieldName, value);
- });
+ resolvers[typeName][fieldName] = (
+ root: any,
+ args: any,
+ context: any,
+ info: GraphQLResolveInfo,
+ ) => {
+ const resolverData = {
+ root,
+ args,
+ context,
+ info,
+ random: Date.now().toString(),
+ env: process.env,
+ };
+ updateStoreFactories.forEach(
+ ({ updateStoreConfig, keyFactory, valueFactory }) => {
+ const key = keyFactory(resolverData);
+ const value = valueFactory(resolverData);
+ store.set(updateStoreConfig.type, key, updateStoreConfig.fieldName, value);
+ },
+ );
const key = getFromStoreKeyFactory(resolverData);
return store.get(fieldConfig.store.type, key, fieldConfig.store.fieldName);
};
} else if ('store' in fieldConfig) {
const keyFactory = getInterpolatedStringFactory(fieldConfig.store.key);
resolvers[typeName] = resolvers[typeName] || {};
- resolvers[typeName][fieldName] = (root: any, args: any, context: any, info: GraphQLResolveInfo) => {
+ resolvers[typeName][fieldName] = (
+ root: any,
+ args: any,
+ context: any,
+ info: GraphQLResolveInfo,
+ ) => {
const key = keyFactory({ root, args, context, info, env: process.env });
return store.get(fieldConfig.store.type, key, fieldConfig.store.fieldName);
};
@@ -107,7 +137,7 @@ export default function useMock(config: MeshPluginOptions {
return exportedVal$.then(exportedVal =>
- typeof exportedVal === 'function' ? exportedVal(store) : exportedVal
+ typeof exportedVal === 'function' ? exportedVal(store) : exportedVal,
);
};
}
diff --git a/packages/plugins/mock/tests/mocking.spec.ts b/packages/plugins/mock/tests/mocking.spec.ts
index 88ffdbe575a9b..181cc0c759e66 100644
--- a/packages/plugins/mock/tests/mocking.spec.ts
+++ b/packages/plugins/mock/tests/mocking.spec.ts
@@ -234,7 +234,10 @@ describe('mocking', () => {
}
}
`);
- const getUserResult: any = await enveloped.execute({ schema: enveloped.schema, document: GET_USER });
+ const getUserResult: any = await enveloped.execute({
+ schema: enveloped.schema,
+ document: GET_USER,
+ });
expect(getUserResult?.data?.user?.id).toBe(addedUserId);
expect(getUserResult?.data?.user?.name).toBe('John Doe');
const UPDATE_USER = enveloped.parse(/* GraphQL */ `
@@ -245,7 +248,10 @@ describe('mocking', () => {
}
}
`);
- const updateUserResult: any = await enveloped.execute({ schema: enveloped.schema, document: UPDATE_USER });
+ const updateUserResult: any = await enveloped.execute({
+ schema: enveloped.schema,
+ document: UPDATE_USER,
+ });
expect(updateUserResult?.data?.updateUser?.id).toBe(addedUserId);
expect(updateUserResult?.data?.updateUser?.name).toBe('Jane Doe');
});
@@ -324,7 +330,10 @@ describe('mocking', () => {
}
}
`);
- const addUserResult: any = await enveloped.execute({ schema: enveloped.schema, document: ADD_USER });
+ const addUserResult: any = await enveloped.execute({
+ schema: enveloped.schema,
+ document: ADD_USER,
+ });
expect(addUserResult?.data?.addUser?.name).toBe('John Doe');
const addedUserId = addUserResult.data.addUser.id;
const GET_USER = enveloped.parse(/* GraphQL */ `
@@ -335,7 +344,10 @@ describe('mocking', () => {
}
}
`);
- const getUserResult: any = await enveloped.execute({ schema: enveloped.schema, document: GET_USER });
+ const getUserResult: any = await enveloped.execute({
+ schema: enveloped.schema,
+ document: GET_USER,
+ });
expect(getUserResult?.data?.user?.id).toBe(addedUserId);
expect(getUserResult?.data?.user?.name).toBe('John Doe');
const UPDATE_USER = parse(/* GraphQL */ `
@@ -346,7 +358,10 @@ describe('mocking', () => {
}
}
`);
- const updateUserResult: any = await enveloped.execute({ schema: enveloped.schema, document: UPDATE_USER });
+ const updateUserResult: any = await enveloped.execute({
+ schema: enveloped.schema,
+ document: UPDATE_USER,
+ });
expect(updateUserResult?.data?.updateUser?.id).toBe(addedUserId);
expect(updateUserResult?.data?.updateUser?.name).toBe('Jane Doe');
});
diff --git a/packages/plugins/mock/tests/mocks.ts b/packages/plugins/mock/tests/mocks.ts
index 5f0bdb43d4770..5f83e4f58c25d 100644
--- a/packages/plugins/mock/tests/mocks.ts
+++ b/packages/plugins/mock/tests/mocks.ts
@@ -2,9 +2,16 @@ import { MockStore } from '@graphql-tools/mock';
export const id = 'sample-id';
export const fullName = 'John Snow';
-export const GetUserMock = (_: never, { id }: { id: string }, { mockStore }: { mockStore: MockStore }) =>
- mockStore.get('User', id);
-export const AddUserMock = (_: never, { name }: { name: string }, { mockStore }: { mockStore: MockStore }) => {
+export const GetUserMock = (
+ _: never,
+ { id }: { id: string },
+ { mockStore }: { mockStore: MockStore },
+) => mockStore.get('User', id);
+export const AddUserMock = (
+ _: never,
+ { name }: { name: string },
+ { mockStore }: { mockStore: MockStore },
+) => {
const newUserId = Date.now().toString();
mockStore.set('User', newUserId, 'name', name);
return mockStore.get('User', newUserId);
@@ -12,7 +19,7 @@ export const AddUserMock = (_: never, { name }: { name: string }, { mockStore }:
export const UpdateUserMock = (
_: never,
{ id, name }: { id: string; name: string },
- { mockStore }: { mockStore: MockStore }
+ { mockStore }: { mockStore: MockStore },
) => {
mockStore.set('User', id, { name });
return mockStore.get('User', id);
diff --git a/packages/plugins/newrelic/src/index.ts b/packages/plugins/newrelic/src/index.ts
index 71c6540c9832d..61d91ed439916 100644
--- a/packages/plugins/newrelic/src/index.ts
+++ b/packages/plugins/newrelic/src/index.ts
@@ -10,10 +10,12 @@ import { shim as instrumentationApi } from 'newrelic';
const EnvelopAttributeName = 'Envelop_NewRelic_Plugin';
-export default function useMeshNewrelic(options: MeshPluginOptions): MeshPlugin {
+export default function useMeshNewrelic(
+ options: MeshPluginOptions,
+): MeshPlugin {
if (!instrumentationApi?.agent) {
options.logger.error(
- 'Agent unavailable. Please check your New Relic Agent configuration and ensure New Relic is enabled.'
+ 'Agent unavailable. Please check your New Relic Agent configuration and ensure New Relic is enabled.',
);
return {};
}
@@ -38,11 +40,12 @@ export default function useMeshNewrelic(options: MeshPluginOptions
+ options: MeshPluginOptions,
): MeshPlugin {
return {
onPluginInit({ addPlugin }) {
@@ -22,7 +22,7 @@ export default function useMeshOperationFieldPermissions(
}
return allowedFields;
},
- })
+ }),
);
},
};
diff --git a/packages/plugins/prometheus/src/index.ts b/packages/plugins/prometheus/src/index.ts
index 7b50f2b1049d7..e0595460f3870 100644
--- a/packages/plugins/prometheus/src/index.ts
+++ b/packages/plugins/prometheus/src/index.ts
@@ -5,7 +5,7 @@ import { Histogram, register as defaultRegistry, Registry } from 'prom-client';
import type { Plugin as YogaPlugin } from 'graphql-yoga';
export default async function useMeshPrometheus(
- pluginOptions: MeshPluginOptions
+ pluginOptions: MeshPluginOptions,
): Promise & YogaPlugin> {
const registry = pluginOptions.registry
? await loadFromModuleExportExpression(pluginOptions.registry, {
@@ -32,7 +32,7 @@ export default async function useMeshPrometheus(
usePrometheus({
...pluginOptions,
registry,
- })
+ }),
);
},
onDelegate({ sourceName, typeName, fieldName, args, key }) {
@@ -49,7 +49,7 @@ export default async function useMeshPrometheus(
args: JSON.stringify(args),
key: JSON.stringify(key),
},
- duration
+ duration,
);
};
}
@@ -70,7 +70,7 @@ export default async function useMeshPrometheus(
statusText: response.statusText,
responseHeaders: JSON.stringify(getHeadersObj(response.headers)),
},
- duration
+ duration,
);
};
}
diff --git a/packages/plugins/response-cache/src/index.ts b/packages/plugins/response-cache/src/index.ts
index 610f3c57f96f9..862e74e60665c 100644
--- a/packages/plugins/response-cache/src/index.ts
+++ b/packages/plugins/response-cache/src/index.ts
@@ -4,8 +4,8 @@ import { useResponseCache, UseResponseCacheParameter } from '@graphql-yoga/plugi
import { hashObject, stringInterpolator } from '@graphql-mesh/string-interpolation';
import { process } from '@graphql-mesh/cross-helpers';
-const defaultBuildResponseCacheKey: UseResponseCacheParameter['buildResponseCacheKey'] = async params =>
- hashObject(params);
+const defaultBuildResponseCacheKey: UseResponseCacheParameter['buildResponseCacheKey'] =
+ async params => hashObject(params);
function generateSessionIdFactory(sessionIdDef: string) {
if (sessionIdDef == null) {
@@ -28,7 +28,9 @@ function generateEnabledFactory(ifDef: string) {
};
}
-function getBuildResponseCacheKey(cacheKeyDef: string): UseResponseCacheParameter['buildResponseCacheKey'] {
+function getBuildResponseCacheKey(
+ cacheKeyDef: string,
+): UseResponseCacheParameter['buildResponseCacheKey'] {
return function buildResponseCacheKey(cacheKeyParameters) {
let cacheKey = stringInterpolator.parse(cacheKeyDef, {
...cacheKeyParameters,
@@ -41,7 +43,9 @@ function getBuildResponseCacheKey(cacheKeyDef: string): UseResponseCacheParamete
};
}
-function getShouldCacheResult(shouldCacheResultDef: string): UseResponseCacheParameter['shouldCacheResult'] {
+function getShouldCacheResult(
+ shouldCacheResultDef: string,
+): UseResponseCacheParameter['shouldCacheResult'] {
return function shouldCacheResult({ result }) {
// eslint-disable-next-line no-new-func
return new Function(`return ${shouldCacheResultDef}`)();
@@ -60,7 +64,7 @@ function getCacheForResponseCache(meshCache: KeyValueCache): UseResponseCachePar
const entryId = `${typename}.${id}`;
await meshCache.set(`response-cache:${entryId}:${responseId}`, {}, ttlConfig);
await meshCache.set(`response-cache:${responseId}:${entryId}`, {}, ttlConfig);
- })
+ }),
);
return meshCache.set(`response-cache:${responseId}`, data, ttlConfig);
},
@@ -69,15 +73,17 @@ function getCacheForResponseCache(meshCache: KeyValueCache): UseResponseCachePar
await Promise.all(
[...entitiesToRemove].map(async ({ typename, id }) => {
const entryId = `${typename}.${id}`;
- const cacheEntriesToDelete = await meshCache.getKeysByPrefix(`response-cache:${entryId}:`);
+ const cacheEntriesToDelete = await meshCache.getKeysByPrefix(
+ `response-cache:${entryId}:`,
+ );
await Promise.all(
cacheEntriesToDelete.map(cacheEntryName => {
const [, , responseId] = cacheEntryName.split(':');
responseIdsToCheck.add(responseId);
return meshCache.delete(entryId);
- })
+ }),
);
- })
+ }),
);
await Promise.all(
[...responseIdsToCheck].map(async responseId => {
@@ -85,13 +91,15 @@ function getCacheForResponseCache(meshCache: KeyValueCache): UseResponseCachePar
if (cacheEntries.length === 0) {
await meshCache.delete(`response-cache:${responseId}`);
}
- })
+ }),
);
},
};
}
-export default function useMeshResponseCache(options: MeshPluginOptions): Plugin {
+export default function useMeshResponseCache(
+ options: MeshPluginOptions,
+): Plugin {
const ttlPerType: Record = {};
const ttlPerSchemaCoordinate: Record = {};
if (options.ttlPerCoordinate) {
@@ -109,13 +117,19 @@ export default function useMeshResponseCache(options: MeshPluginOptions
+ pluginOptions: MeshPluginOptions,
): MeshPlugin {
if (typeof pluginOptions.if === 'boolean') {
if (!pluginOptions.if) {
@@ -39,7 +39,11 @@ export default function useSnapshot(
async onFetch({ url, options, setFetchFn }) {
if (matches.some(matcher => matcher.match(url))) {
const snapshotFileName = calculateCacheKey(url, options);
- const snapshotPath = path.join(pluginOptions.baseDir, snapshotsDir, `${snapshotFileName}.json`);
+ const snapshotPath = path.join(
+ pluginOptions.baseDir,
+ snapshotsDir,
+ `${snapshotFileName}.json`,
+ );
if (await pathExists(snapshotPath)) {
setFetchFn(async () => {
const snapshotFile = await fs.promises.readFile(snapshotPath, 'utf-8');
@@ -54,7 +58,11 @@ export default function useSnapshot(
}
return async ({ response, setResponse }) => {
const contentType = response.headers.get('content-type');
- if (contentType.includes('json') || contentType.includes('text') || contentType.includes('xml')) {
+ if (
+ contentType.includes('json') ||
+ contentType.includes('text') ||
+ contentType.includes('xml')
+ ) {
const snapshot: SnapshotEntry = {
text: await response.text(),
headersObj: getHeadersObj(response.headers),
@@ -67,7 +75,7 @@ export default function useSnapshot(
headers: snapshot.headersObj,
status: snapshot.status,
statusText: snapshot.statusText,
- })
+ }),
);
}
};
diff --git a/packages/plugins/statsd/src/index.ts b/packages/plugins/statsd/src/index.ts
index 54f22fe3a0c3f..87772321c06ac 100644
--- a/packages/plugins/statsd/src/index.ts
+++ b/packages/plugins/statsd/src/index.ts
@@ -12,7 +12,9 @@ const metricNames = {
fetchLatency: 'fetch.latency',
};
-export default function useMeshStatsd(pluginOptions: MeshPluginOptions): MeshPlugin {
+export default function useMeshStatsd(
+ pluginOptions: MeshPluginOptions,
+): MeshPlugin {
const client = new StatsD(pluginOptions.client);
const prefix = pluginOptions.prefix || 'graphql';
return {
@@ -21,7 +23,7 @@ export default function useMeshStatsd(pluginOptions: MeshPluginOptions[]) {
+const memoizedGetEnvelopedFactory = memoize1(function getEnvelopedFactory(
+ plugins: MeshPlugin[],
+) {
return envelop({
plugins,
});
@@ -85,13 +87,19 @@ export function wrapFetchWithPlugins(plugins: MeshPlugin[]): MeshFetch {
throw new TypeError(`First parameter(url) of 'fetch' must be a string, got ${inspect(url)}`);
}
if (options != null && typeof options !== 'object') {
- throw new TypeError(`Second parameter(options) of 'fetch' must be an object, got ${inspect(options)}`);
+ throw new TypeError(
+ `Second parameter(options) of 'fetch' must be an object, got ${inspect(options)}`,
+ );
}
if (context != null && typeof context !== 'object') {
- throw new TypeError(`Third parameter(context) of 'fetch' must be an object, got ${inspect(context)}`);
+ throw new TypeError(
+ `Third parameter(context) of 'fetch' must be an object, got ${inspect(context)}`,
+ );
}
if (info != null && typeof info !== 'object') {
- throw new TypeError(`Fourth parameter(info) of 'fetch' must be an object, got ${inspect(info)}`);
+ throw new TypeError(
+ `Fourth parameter(info) of 'fetch' must be an object, got ${inspect(info)}`,
+ );
}
let fetchFn: MeshFetch;
const doneHooks: OnFetchHookDone[] = [];
@@ -128,13 +136,15 @@ export function wrapFetchWithPlugins(plugins: MeshPlugin[]): MeshFetch {
// Use in-context-sdk for tracing
function createProxyingResolverFactory(
apiName: string,
- rootTypeMap: Map
+ rootTypeMap: Map,
): CreateProxyingResolverFn {
return function createProxyingResolver({ operation }) {
const rootType = rootTypeMap.get(operation);
return function proxyingResolver(root, args, context, info) {
if (!context[apiName][rootType.name][info.fieldName]) {
- throw new Error(`${info.fieldName} couldn't find in ${rootType.name} of ${apiName} as a ${operation}`);
+ throw new Error(
+ `${info.fieldName} couldn't find in ${rootType.name} of ${apiName} as a ${operation}`,
+ );
}
return context[apiName][rootType.name][info.fieldName]({ root, args, context, info });
};
@@ -161,21 +171,23 @@ export async function getMesh(options: GetMeshOptions): Promise {
let failed = false;
const initialPluginList: MeshPlugin[] = [
// TODO: Not a good practise to expect users to be a Yoga user
- useExtendContext(({ request, req }: { request: Request; req?: { headers?: Record } }) => {
- // Maybe Node-like environment
- if (req?.headers) {
- return {
- headers: req.headers,
- };
- }
- // Fetch environment
- if (request?.headers) {
- return {
- headers: getHeadersObj(request.headers),
- };
- }
- return {};
- }),
+ useExtendContext(
+ ({ request, req }: { request: Request; req?: { headers?: Record } }) => {
+ // Maybe Node-like environment
+ if (req?.headers) {
+ return {
+ headers: req.headers,
+ };
+ }
+ // Fetch environment
+ if (request?.headers) {
+ return {
+ headers: getHeadersObj(request.headers),
+ };
+ }
+ return {};
+ },
+ ),
useExtendContext(() => ({
pubsub,
cache,
@@ -216,7 +228,12 @@ export async function getMesh(options: GetMeshOptions): Promise {
if (!wrapTransforms?.length && noWrapTransforms?.length) {
sourceLogger.debug(`${noWrapTransforms.length} bare transforms found and applying`);
- apiSchema = applySchemaTransforms(apiSchema, source as SubschemaConfig, null, noWrapTransforms);
+ apiSchema = applySchemaTransforms(
+ apiSchema,
+ source as SubschemaConfig,
+ null,
+ noWrapTransforms,
+ );
} else {
transforms = apiSource.transforms;
}
@@ -237,14 +254,16 @@ export async function getMesh(options: GetMeshOptions): Promise {
sourceLogger.error(`Failed to generate the schema`, e);
failed = true;
}
- })
+ }),
);
if (failed) {
throw new Error(
`Schemas couldn't be generated successfully. Check for the logs by running Mesh${
- process.env.DEBUG == null ? ' with DEBUG=1 environmental variable to get more verbose output' : ''
- }.`
+ process.env.DEBUG == null
+ ? ' with DEBUG=1 environmental variable to get more verbose output'
+ : ''
+ }.`,
);
}
@@ -262,7 +281,10 @@ export async function getMesh(options: GetMeshOptions): Promise {
for (const rootLevelTransform of transforms) {
if (rootLevelTransform.noWrap) {
if (rootLevelTransform.transformSchema) {
- unifiedSubschema.schema = rootLevelTransform.transformSchema(unifiedSubschema.schema, unifiedSubschema);
+ unifiedSubschema.schema = rootLevelTransform.transformSchema(
+ unifiedSubschema.schema,
+ unifiedSubschema,
+ );
}
} else {
unifiedSubschema.transforms.push(rootLevelTransform);
@@ -287,7 +309,12 @@ export async function getMesh(options: GetMeshOptions): Promise {
onDelegateHooks.push(plugin.onDelegate);
}
}
- inContextSDK$ = getInContextSDK(subschema.transformedSchema, rawSources, logger, onDelegateHooks);
+ inContextSDK$ = getInContextSDK(
+ subschema.transformedSchema,
+ rawSources,
+ logger,
+ onDelegateHooks,
+ );
}
return inContextSDK$;
}),
@@ -304,12 +331,17 @@ export async function getMesh(options: GetMeshOptions): Promise {
function createExecutor(globalContext: any = EMPTY_CONTEXT_VALUE): MeshExecutor {
const getEnveloped = memoizedGetEnvelopedFactory(plugins);
const { schema, parse, execute, subscribe, contextFactory } = getEnveloped(globalContext);
- return async function meshExecutor(
+ return async function meshExecutor<
+ TVariables = any,
+ TContext = any,
+ TRootValue = any,
+ TData = any,
+ >(
documentOrSDL: GraphQLOperation,
variableValues: TVariables = EMPTY_VARIABLES_VALUE,
contextValue: TContext = EMPTY_CONTEXT_VALUE,
rootValue: TRootValue = EMPTY_ROOT_VALUE,
- operationName?: string
+ operationName?: string,
) {
const document = typeof documentOrSDL === 'string' ? parse(documentOrSDL) : documentOrSDL;
const executeFn = memoizedGetOperationType(document) === 'subscription' ? subscribe : execute;
diff --git a/packages/runtime/src/types.ts b/packages/runtime/src/types.ts
index edd81bdc54643..e18f2c2ede69c 100644
--- a/packages/runtime/src/types.ts
+++ b/packages/runtime/src/types.ts
@@ -40,7 +40,7 @@ export type ExecuteMeshFn Promise>;
export type SubscribeMeshFn = (
@@ -48,7 +48,7 @@ export type SubscribeMeshFn Promise | AsyncIterable>>;
export type MeshContext = {
@@ -69,5 +69,5 @@ export type MeshExecutor = (
variables?: TVariables,
context?: TContext,
rootValue?: TRootValue,
- operationName?: string
+ operationName?: string,
) => Promise>;
diff --git a/packages/runtime/src/useSubschema.ts b/packages/runtime/src/useSubschema.ts
index f435380701b7c..a928dcef8879f 100644
--- a/packages/runtime/src/useSubschema.ts
+++ b/packages/runtime/src/useSubschema.ts
@@ -1,5 +1,10 @@
import { applyRequestTransforms, applyResultTransforms } from '@graphql-mesh/utils';
-import { createDefaultExecutor, DelegationContext, applySchemaTransforms, Subschema } from '@graphql-tools/delegate';
+import {
+ createDefaultExecutor,
+ DelegationContext,
+ applySchemaTransforms,
+ Subschema,
+} from '@graphql-tools/delegate';
import {
ExecutionRequest,
getDefinedRootType,
@@ -62,19 +67,24 @@ function getExecuteFn(subschema: Subschema) {
originalRequest,
delegationContext,
transformationContext,
- subschema.transforms
+ subschema.transforms,
);
const originalResult = await executor(transformedRequest);
if (isAsyncIterable(originalResult)) {
return mapAsyncIterator(originalResult, singleResult =>
- applyResultTransforms(singleResult, delegationContext, transformationContext, subschema.transforms)
+ applyResultTransforms(
+ singleResult,
+ delegationContext,
+ transformationContext,
+ subschema.transforms,
+ ),
);
}
const transformedResult = applyResultTransforms(
originalResult,
delegationContext,
transformationContext,
- subschema.transforms
+ subschema.transforms,
);
return transformedResult;
};
diff --git a/packages/runtime/test/getMesh.test.ts b/packages/runtime/test/getMesh.test.ts
index 42b5eb4a45325..93495b1edc814 100644
--- a/packages/runtime/test/getMesh.test.ts
+++ b/packages/runtime/test/getMesh.test.ts
@@ -43,7 +43,9 @@ describe('getMesh', () => {
function createGraphQLSchema(config: CreateSchemaConfiguration) {
const queryTypeName = config.suffixRootTypeNames ? `Query${config.suffix}` : 'Query';
const mutationTypeName = config.suffixRootTypeNames ? `Mutation${config.suffix}` : 'Mutation';
- const subscriptionTypeName = config.suffixRootTypeNames ? `Subscription${config.suffix}` : 'Subscription';
+ const subscriptionTypeName = config.suffixRootTypeNames
+ ? `Subscription${config.suffix}`
+ : 'Subscription';
return makeExecutableSchema({
typeDefs: `
@@ -114,7 +116,7 @@ describe('getMesh', () => {
suffixRootTypeNames: true,
suffixFieldNames: false,
suffixResponses: false,
- })
+ }),
),
merger,
});
@@ -147,7 +149,7 @@ describe('getMesh', () => {
hello2
}
`,
- {}
+ {},
);
expect(result).toMatchInlineSnapshot(`
@@ -186,7 +188,8 @@ describe('getMesh', () => {
],
additionalResolvers: {
Mutation: {
- strikeBack: (root, args, context, info) => context.serviceFoo.Query.helloFoo({ root, args, context, info }),
+ strikeBack: (root, args, context, info) =>
+ context.serviceFoo.Query.helloFoo({ root, args, context, info }),
},
},
});
@@ -197,7 +200,7 @@ describe('getMesh', () => {
strikeBack
}
`,
- {}
+ {},
);
expect(result).toMatchInlineSnapshot(`
diff --git a/packages/runtime/test/useSubschema.test.ts b/packages/runtime/test/useSubschema.test.ts
index dc5e8631fd6b2..b06556d9604c4 100644
--- a/packages/runtime/test/useSubschema.test.ts
+++ b/packages/runtime/test/useSubschema.test.ts
@@ -58,7 +58,7 @@ describe('useSubschema', () => {
},
]),
],
- })
+ }),
);
const getEnveloped = envelop({
plugins: [
diff --git a/packages/store/src/index.ts b/packages/store/src/index.ts
index 1195d61df2a3c..d4fccca8dbe81 100644
--- a/packages/store/src/index.ts
+++ b/packages/store/src/index.ts
@@ -44,16 +44,23 @@ export interface FsStoreStorageAdapterOptions {
export class FsStoreStorageAdapter implements StoreStorageAdapter {
constructor(private options: FsStoreStorageAdapterOptions) {}
private getAbsolutePath(jsFileName: string) {
- return pathModule.isAbsolute(jsFileName) ? jsFileName : pathModule.join(this.options.cwd, jsFileName);
+ return pathModule.isAbsolute(jsFileName)
+ ? jsFileName
+ : pathModule.join(this.options.cwd, jsFileName);
}
- async read(key: string, options: ProxyOptions): Promise {
+ async read(
+ key: string,
+ options: ProxyOptions,
+ ): Promise {
let absoluteModulePath = this.getAbsolutePath(key);
if (this.options.fileType !== 'ts') {
absoluteModulePath += '.' + this.options.fileType;
}
try {
- const importedData = await this.options.importFn(absoluteModulePath).then(m => m.default || m);
+ const importedData = await this.options
+ .importFn(absoluteModulePath)
+ .then(m => m.default || m);
if (this.options.fileType === 'json') {
return await options.fromJSON(importedData, key);
}
@@ -69,7 +76,7 @@ export class FsStoreStorageAdapter implements StoreStorageAdapter {
async write