feat: pull changes from main branch into staging (#374)

* fix: Add `integer` value to metadata template response (#344) * Add integer value and note to metadata templ * Fix lint * update metadata field attrib * fix: DDOC-871: add info on params for mappings (#343) * feat: DDOC-855 add iframeable_embed_url param to box sign request (#340) * feat: DDOC-855 add iframeable_embed param * fix lint issues * Update signer mock id * review updates for parameters * docs: Storage policies: endpoints only accessible by admin (#330) * Add information on access and auth * Correct wording --------- Co-authored-by: Barbara Czyż <[email protected]> * feat: DDOC-880 Modify readme and add tags descriptions (#349) * docs: fix typo * fix: DDOC-880: changes in README and tags desc * Add readme * Fix linting issues * Update content/common/tags.yml Co-authored-by: Justyna Sztyper <[email protected]> * Update content/common/tags.yml Co-authored-by: Justyna Sztyper <[email protected]> * Review fixes --------- Co-authored-by: Justyna Sztyper <[email protected]> * feat: update webpack-dev-server and node scripts * feat: add compiled openapi.json to main root directory * revert: update webpack-dev-server and node scripts * fix: collaboration_allowlist_exempt_target definition (#352) Co-authored-by: wsocha <[email protected]> * Set correct response type on folder_metadata__get_folders_id_metadata_id_id (#351) Co-authored-by: wsocha <[email protected]> * Make id required in user--base.yml (#348) Co-authored-by: wsocha <[email protected]> * feat: update webpack-dev-server and node scripts (#354) * feat: update webpack-dev-server and node scripts * fix: add verification the compiled schema is up to date * fix: update openapi.json --------- Co-authored-by: Wojciech Socha <[email protected]> * feat: Add type field to sign template (#355) * feat: Add type field to sign template * Add openapi.json file * feat: Update sign template signer input (#356) * feat: Update sign template signer input * Update openapi.json * Update openapi.json * fix: mark type as required in search results (#357) * fix: mark type as required in search results * fix: update openapi.json --------- Co-authored-by: Wojciech Socha <[email protected]> * feat: add docs issue template (#358) * feat: add docs issue template * fix: add item reminding of including changes in compiled openapi.json file to checklist in pull request template * fix: change description of two fields in docs issue template (#360) * fix: change docs issue template name (#362) * feat: add docs issue template * fix: add item reminding of including changes in compiled openapi.json file to checklist in pull request template * fix: change docs issue template name * fix: change marker from long to string (#359) * feat: add issue config (#363) * fix: change `accessible_by` in Collaboration to allow setting `Group--Mini` (#364) * feat: pull specification from public api (#367) * fix: Revert "feat: pull specification from public api (#367)" (#368) * DDOC-909: add additional_info param (#369) * DDOC-508: add is_access_only param for collabs (#370) * feat: run codegen generate command to validate API spec (#372) * feat: pull api specification from public-api (#373) * feat: pull api specification from public-api * fix: remove oneOf containing primitive types --------- Co-authored-by: Wojciech Socha <[email protected]> * feat: remove references to content folder (#365) * feat: remove references to content folder * fix: remove spectral linter * fix: remove content folder and docs * fix: update readme --------- Co-authored-by: Barbara Czyż <[email protected]> Co-authored-by: Justyna Sztyper <[email protected]> Co-authored-by: Marcin Hagmajer <[email protected]> Co-authored-by: Minh Nguyen Cong <[email protected]> Co-authored-by: mwwoda <[email protected]> Co-authored-by: Artur Jankowski <[email protected]> Co-authored-by: box-apimgmt <[email protected]>
box · Oct 17, 2023 · 4407712 · 4407712
1 parent bfd9ecb
commit 4407712
Show file tree

Hide file tree

Showing 627 changed files with 71,275 additions and 51,080 deletions.
diff --git a/- b/-
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Box Developer Community
+    url: https://forum.box.com
+    about: Before creating an issue, I have searched the Box Developer Community and my issue isn't already reported there.
+  - name: Issues
+    url: https://github.com/box/box-openapi/issues
+    about: Before creating an issue, I have searched Issues in this repository and my issue isn't already reported there.
+  - name: API Reference
+    url: https://developer.box.com/reference
+    about: Before creating an issue, I have checked that the API documentation doesn't solve my issue.
diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml
@@ -0,0 +1,31 @@
+name: API documentation feedback
+description: Provide feedback on API documentation
+labels: ["documentation"]
+body:
+  - type: textarea
+    attributes:
+      label: Description of the issue
+      description: Describe what you discovered and explain why it is an issue.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Current content
+      description: What does the specification currently say?
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected content
+      description: What should the specification say instead?
+    validations:
+      required: false
+  - type: input
+    id: url
+    attributes:
+      label: Link to the documentation page
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: "Thanks for completing our form!"
diff --git a/.github/ISSUE_TEMPLATE/mistake.md b/.github/ISSUE_TEMPLATE/mistake.md
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,6 @@
 # Description
 
-Please include a summary of the change and which issue is fixed. 
+Please include a summary of the change and which issue is fixed.
 
 If you are a Boxer, please also reference the related `DDOC` or `APIWG` tickets.
 If you do not have a related `Jira` ticket and this is more than a bug fix, then

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,7 +21,8 @@ jobs:
   lint:
     # We run this on the latest ubuntu
     runs-on: ubuntu-latest
-    timeout-minutes: 20
+    timeout-minutes: 10
+
     # We use node 14 and Python 3.8
     strategy:
       matrix:
@@ -34,7 +35,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -52,7 +53,7 @@ jobs:
         run: |
           yarn install
 
-      - name: Lint the content
+      - name: Lint API specification and markdown
         run: |
           yarn lint
 
@@ -61,7 +62,7 @@ jobs:
     # We run this on the latest ubuntu
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'
-    timeout-minutes: 20
+    timeout-minutes: 10
 
     # We use node 14.X
     strategy:
@@ -72,36 +73,37 @@ jobs:
     needs:
       - lint
 
-    # The following steps are performed for each lint job
+    # The following steps are performed for each job
     steps:
       - name: Check out the repo
         uses: actions/checkout@v3
-      
+
       - name: Set up Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Compile the content
+      - name: Build content
         run: |
           yarn install
-          yarn build
+          yarn build:spec
+          yarn build:content
           yarn build:swagger
 
-      - name: Push compiled content
+      - name: Push API specification
         uses: s0/[email protected]
         env:
           REPO: self
           BRANCH: en
-          FOLDER: compiled/openapi
+          FOLDER: compiled/spec
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Push GH pages for redundancy
         uses: s0/[email protected]
         env:
           REPO: self
           BRANCH: gh-pages
-          FOLDER: compiled/openapi
+          FOLDER: compiled/content
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Push Swagger 2.0 backport
@@ -156,7 +158,7 @@ jobs:
     # We run this on the latest ubuntu
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/staging'
-    timeout-minutes: 20
+    timeout-minutes: 10
 
     # We use node 14.X
     strategy:
@@ -167,7 +169,7 @@ jobs:
     needs:
       - lint
 
-    # The following steps are performed for each lint job
+    # The following steps are performed for each job
     steps:
       - name: Check out the repo
         uses: actions/checkout@v3
@@ -177,17 +179,17 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
 
-      - name: Compile the content
+      - name: Build content
         run: |
           yarn install
-          yarn build
+          yarn build:spec
 
-      - name: Push compiled content
+      - name: Push API specification
         uses: s0/[email protected]
         env:
           REPO: self
           BRANCH: en-staging
-          FOLDER: compiled/openapi
+          FOLDER: compiled/spec
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: "Trigger Netlify deployment"
@@ -214,31 +216,25 @@ jobs:
           SLACK_AVATAR: "https://avatars3.githubusercontent.com/u/8659759?s=200&v=4"
         with:
           args: "Error running `deploy-staging` job in OpenAPI CI"
-  
+
   # Build the OpenAPI spec and validate using Codegen
   validate-spec:
     name: Validate OpenAPI spec using Codegen
     # We run this on the latest ubuntu
     runs-on: ubuntu-latest
 
-    # The following steps are performed for each lint job
+    # The following steps are performed for each job
     steps:
       - name: Check out the repo
         uses: actions/checkout@v3
         with:
           path: box-openapi
-      
+
       - name: Set up Node.js 16.x
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
 
-      - name: Compile the content
-        run: |
-          cd $GITHUB_WORKSPACE/box-openapi
-          yarn install
-          yarn build
-      
       - name: Check out the Codegen repo
         uses: actions/checkout@v3
         with:
@@ -253,5 +249,5 @@ jobs:
           npm install
           cd scripts
           npm install
-          cp $GITHUB_WORKSPACE/box-openapi/compiled/openapi/openapi.json .
-          npm run validate ./openapi.json
+          cp $GITHUB_WORKSPACE/box-openapi/openapi.json .
+          npm run generate ./openapi.json output typescript,swift,python,c#
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ src/dev/scripts/objects/*
 src/dev/index.build.js
 migrate.js
 compiled
+yarn-error.log
 
 #Intelij Idea
 *.iml

diff --git a/.spelling b/.spelling
@@ -59,4 +59,5 @@ uri
 url 
 dropdown
 special
-org
+org
+GitHub
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
 # Box OpenAPI 3.0 Specification
 
+<!-- markdownlint-disable line-length -->
 ![CI](https://github.com/box/box-openapi/workflows/CI/badge.svg) [![Project Status](https://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
 
-This repository contains the build system for the Box OpenAPI 3.0 Specification
-(OAS3) of the
-[Box Platform API](https://developers.box.com/).
+This repository contains the build system for the Box OpenAPI 3.0 Specification (OAS3) of the [Box Platform API](https://developers.box.com/).
 
 ## Downloads
 
@@ -13,30 +12,20 @@ specification. For a combined, resolved version please have a look at the
 following builds.
 
 [![OpenAPI (en)](https://img.shields.io/static/v1.svg?label=OpenAPI%203&message=Download&color=grey&labelColor=0361D4&style=for-the-badge&logoColor=white)](https://raw.githubusercontent.com/box/box-openapi/en/openapi.json)
-[![OpenAPI (en)](https://img.shields.io/static/v1.svg?label=OpenAPI%203&message=ダウンロード&color=grey&labelColor=0361D4&style=for-the-badge&logoColor=white)](https://raw.githubusercontent.com/box/box-openapi/jp/openapi.json)
+[![OpenAPI (jp)](https://img.shields.io/static/v1.svg?label=OpenAPI%203&message=ダウンロード&color=grey&labelColor=0361D4&style=for-the-badge&logoColor=white)](https://raw.githubusercontent.com/box/box-openapi/jp/openapi.json)
 
 [![Swagger (en)](https://img.shields.io/static/v1.svg?label=Swagger%202&message=Backported&color=grey&labelColor=0361D4&style=for-the-badge)](https://github.com/box/box-openapi/tree/swagger-2.0)
-[![Swagger (en)](https://img.shields.io/static/v1.svg?label=Swagger%202&message=Legacy%20/%20Incomplete&color=grey&labelColor=lightgrey&style=for-the-badge)](https://github.com/box/box-openapi/tree/legacy-swagger-2.0/v2.0)
+[![Swagger (jp)](https://img.shields.io/static/v1.svg?label=Swagger%202&message=Legacy%20/%20Incomplete&color=grey&labelColor=lightgrey&style=for-the-badge)](https://github.com/box/box-openapi/tree/legacy-swagger-2.0/v2.0)
 
 ## Swagger 2.0
 
 The older and incomplete Swagger 2.0 specification is still available on the
-[Swagger 2.0](https://github.com/box/box-openapi/tree/swagger_2.0) branch.
+[Swagger 2.0](https://github.com/box/box-openapi/tree/legacy-swagger-2.0/v2.0) branch.
 
-## Development & Contribution
+## Contribution
 
-Please follow the [contribution guidelines](./CONTRIBUTING.md) when contributing
-to the source of this project.
-
-1. [Installation & setup](./docs/index.md)
-1. [Notes for Box employees](./docs/boxers.md)
-1. [The OpenAPI structure and custom attributes](./docs/structure.md)
-1. [Adding a new API resource](./docs/add-resource.md)
-1. [Base, mini, standard, and full API resources](./docs/variants.md)
-1. [Adding a new API endpoint](./docs/add-endpoint.md)
-1. [Contributing a pull request](./docs/pull-request.md)
-1. [Markdown styleguide](./docs/markdown.md)
-1. [Updating dependencies](./docs/dependencies.md)
+* If you notice that the content requires improvements or you feel that some information is missing add a new [GitHub issue](https://github.com/box/box-openapi/issues) and describe the issue.
+* If you are a Boxer, create a Developer Documentation ticket or use the `#dev-docs-feedback` Slack channel for assistance.
 
 ## Usage & License
 
@@ -50,3 +39,4 @@ Unless required by applicable law or agreed to in writing, software distributed
 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
+<!-- markdownlint-enable line-length -->
diff --git a/content/attributes/access_token--embedded.yml b/content/attributes/access_token--embedded.yml
-Original file line number
+Diff line change
@@ Expand Up / @@ -59,4 +59,5 @@ uri @@
     url
     dropdown
     special
-    org
+    org
+    GitHub