Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
b422e229
Commit
b422e229
authored
Dec 20, 2019
by
Evan Read
Committed by
Achilleas Pipinellis
Dec 20, 2019
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add documentation for OpenAPI viewer
parent
786fc1ba
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
29 additions
and
0 deletions
+29
-0
doc/user/project/repository/index.md
doc/user/project/repository/index.md
+29
-0
No files found.
doc/user/project/repository/index.md
View file @
b422e229
...
...
@@ -116,6 +116,35 @@ rendered to HTML when viewed.
Interactive features, including JavaScript plots, will not work when viewed in
GitLab.
### OpenAPI viewer
> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/19515) in GitLab 12.6.
GitLab can render OpenAPI specification files with its file viewer, provided
their filenames include
`openapi`
or
`swagger`
and their extension is
`yaml`
,
`yml`
, or
`json`
. The following examples are all correct:
-
`openapi.yml`
-
`openapi.yaml`
-
`openapi.json`
-
`swagger.yml`
-
`swagger.yaml`
-
`swagger.json`
-
`gitlab_swagger.yml`
-
`openapi_gitlab.yml`
-
`OpenAPI.YML`
-
`openapi.Yaml`
-
`openapi.JSON`
-
`openapi.gitlab.yml`
-
`gitlab.openapi.yml`
Then, to render them:
1.
Navigate to the OpenAPI file in your repository in GitLab's UI.
1.
Click the "Display OpenAPI" button which is located between the "Display source"
and "Edit" buttons (when an OpenAPI file is found, it replaces the
"Display rendered file" button).
## Branches
For details, see
[
Branches
](
branches/index.md
)
.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment