+
+
+
+
+
+ Type:
+
+
+ + Uh oh! It looks like there was an error either receiving data from the server or + sending data to it. You have a couple options at this point. You can reload the + page or we can shoot you back to the Dashboard. Your choice! +
+{{ stackTrace() }}
+ + You attempted to navigate to a page that does not exist! I guess you should either + hit the back button or go back to the Dashboard (button below). +
+ ++ It appears you attempted to add or create something that already exists + in Apicurio Studio. Instead of adding it again, try finding the resource + that is already there and editing it! +
++ We couldn't reach the Apicurio Studio server! Perhaps try reloading this + page in a few minutes? Maybe check your internet connection? +
++ Something unexpected happened and we aren't sure how to deal with it. + You could try reloading the page, or you could just go back to the + Dashboard. See the buttons below... +
+{{api.description}}
++ It seems you have no APIs in the Studio yet. This is probably the first time you've used it and haven't + created or improted any APIs yet! +
++ Click below to either create a new API or import an existing API to the Studio. +
+Loading API Designs...
+ +Do you really want to delete the selected API?
+Do you really want to delete the {{ selectedApis.length }} selected APIs?
+ ++ Here you can create a brand new API by telling us the name (and description) of the new API. +
++ Hey there! Here you can import an existing API to the Studio by either giving us the OpenAPI document or + telling us where we can get it. +
++ Choose from the following options: +
+Loading API information...
+ +Loading contributors data...
+Loading API activity...
+ +Do you really want to delete this API?
+Loading invitation, please wait...
++ You have been invited by {{ invitation.createdBy }} to collaborate on an + API Design. Would you like to accept? +
++ (Invitation created on {{ invitation.createdOn | date }}) +
+Accepting invitation, please wait...
+Loading collaborator information...
+ +Loading invitations...
+ +Do you really want to remove this collaborator?
+Copy the following link to your clipboard and then send it to someone you want to collaborate with!
++ Use this section to define the properties that make up this definition. +
+This section allows you to modify the Name, Version, and Description of the API.
++ Update the information contained in this section to provide users of the API details + about how to contact you should they need help. +
++ For more information about this API, users can contact {{ contactName() }} or visit {{ contactUrl() }}. +
+ ++ Is your API licensed? + Configure that here! We'll help by showing you the most common licenses + you can choose from (and even describe each one a little bit!). +
+You have configured a license that we are not familiar with. For information about the license, click the link above! Or else click the button below to choose a different license...
+ ++ Use this section to configure your API's security options. There are three types of + security you may choose from (each with its own specific configuration details): +
+ +| Name | +Security Type | +Description | ++ |
|---|---|---|---|
| {{ scheme.schemeName() }} | +{{ scheme.type }} | +
+
+
+
+
+ |
+
+ In this section you can easily edit the Name and + Description of the Operation. +
++ This section is visible because the path/endpoint this operation belongs to has dynamic parameters. + Configure the parameters' descriptions and types below. +
++ Use this section to configure the operation's Request Body. Typically a + request body is used for PUT and POST only. Other operation + types usually do not include a body. +
++ An operation may, optionally, allow additional options to be sent via URL query + parameters. This section allows you to document what query parameters are + accepted/expected by this operation. +
++ Every operation must include at least one Response. Multiple responses (with + different HTTP response codes) are possible for each operation - so add as many as you like. + Some common choices for HTTP responses are: +
++ In this section you can easily edit the Name and + Description of the Operation. +
++ This section is visible because the path/endpoint this operation belongs to has dynamic parameters. + Configure the parameters' descriptions and types below. +
++ Use this section to configure the operation's Request Body. Typically a + request body is used for PUT and POST only. Other operation + types usually do not include a body. +
++ An operation may, optionally, allow additional options to be sent via URL query + parameters. This section allows you to document what query parameters are + accepted/expected by this operation. +
++ Every operation must include at least one Response. Multiple responses (with + different HTTP response codes) are possible for each operation - so add as many as you like. + Some common choices for HTTP responses are: +
++ This section is visible because this path has at least one dynamic path parameter. + Here you can configure information about the path parameter, such as its description + and type. This information will be inherited by all operations in the path (but can + optionally be overridden by each respective operation). +
++ Use this section to define HTTP Query Parameters for all of the + Operations in this path. These query parameters will apply to all operations and + can be overridden (though not removed) at the operation level. +
++ Below you will find a list of all possible Operations that could be + supported by this path. You can quickly indicate that this path supports these operations + by clicking the appropriate Create Operation button. You can also quickly + edit the Name and Description of each operation directly + from this list. +
++ Note: to configure a single operation (inputs, outputs, etc) simply + click the colored operation name such as GET or PUT. +
+This section provides additional information about the Validation Problem we found.
+{{ problem.nodePath.toString() }}
+
+ {{ description }}
+| Server | +Description | ++ |
|---|---|---|
| + |
+
+
+
+
+ |
+
+ The core of any REST API is the set of resources/paths it exposes. Each path is of + the form /path/to/resource and can support a number of operations such + as GET, POST, and DELETE. +
++ Note that paths can have parameters, which are defined using bracket syntax, like this: +
+/root/resources/{{ '{' }}resourceId}/subresource/{{ '{' }}subresourceId}+
+ The result is a path with two dynamic components: resourceId and subresourceId. +
++ It is often necessary for many operations to return the same type of data + (or a list of that same data type). Rather than define the same data type + multiple times within each operation, you can create named Definitions + in this section. These can then be referenced in the Request Body + and also Responses of any Operation in the API. +
+Loading API definition...
+ +Opening an API Design editing session...
+ ++ Hey {{ (user() | async).name }}, thanks for logging into Apicurio Studio. Hopefully + you're finding it easy to use this tool to design and collaborate on new (and existing) APIs. +
+ ++ We couldn't find any APIs for you - it's possible that you have not yet created/imported any APIs to the studio. + Or perhaps you have some APIs but haven't worked on them recently. Pick an action below that makes sense + for you! +
+{{api.description}}
+Loading linked accounts...
+ ++ Account linking has failed because you were not logged in. This has caused + the process to fail, so you must go back to the Accounts page and try again. +
++ Account linking has failed because no Identity Provider for accounts of type + {{ accountType }} has been configured. Please contact your + system administrator to resolve this configuration problem. +
++ An unexpected error occurred while trying to create a linked account. The process + has failed, so you must go back and try again. +
++ You've successfully authorized Apicurio Studio with + GitHub + GitLab + Bitbucket + and we are now finalizing the link. This should only take a + moment, after which you will be redirected back to the + Settings >> Accounts page. +
+Finalizing account link, please wait...
++ This account has already been successfully linked. Click the button below + to return to the Settings page. +
+