Skip to content
This repository has been archived by the owner on Oct 31, 2022. It is now read-only.

Commit

Permalink
Update action
Browse files Browse the repository at this point in the history
  • Loading branch information
impart-security committed Oct 21, 2022
1 parent d95488f commit 7a3237c
Show file tree
Hide file tree
Showing 9 changed files with 5,989 additions and 201 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@

# Specification update action

This action updates a specification for a given organization.

## Inputs

### `access_token`

**Required** An access token with both `write:org_specs` and `read:org_specs` permissions.

### `org_id`

**Required** The ID of the organization.

### `spec_id`

**Required** The ID of the specification.

### `path`

**Required** The path to the spec file.

### `name`

**Optional** The name of the specification. Defaults to the current specification name.

### `hostname`

**Optional** The hostname of the API.

## Example usage

```yaml
uses: ./.github/actions/spec-update-action
with:
access_token: {{ secrets.ACCESS_TOKEN }}
org_id: "c3172c84-bba2-4431-b3b6-edcaf5153417"
spec_id: "7ed3f413-e25e-4e7f-8c90-f409bf1b18cd"
path: "./spec.yaml"
```
30 changes: 30 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: "Specification update"
description: "Update a specification for a given organization."
inputs:
access_token:
description: "An access token with both `write:org_specs` and `read:org_specs` permissions."
required: true
default: ""
org_id:
description: "The ID of the organization."
required: true
default: ""
spec_id:
description: "The ID of the specification."
required: true
default: ""
path:
description: "The path to the spec file."
required: true
default: ""
name:
description: "The name of the specification."
required: false
default: ""
hostname:
description: "The hostname of the api."
required: false
default: "api.impartsecurity.net"
runs:
using: "node16"
main: "dist/index.js"
Loading

0 comments on commit 7a3237c

Please sign in to comment.