Skip to content
This repository was archived by the owner on Jan 11, 2025. It is now read-only.

Refactor API documentation and release to Docusaurus #4

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docusaurus/
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Enable Powerlevel10k instant prompt. Should stay close to the top of ~/.zshrc.
# Initialization code that may require console input (password prompts, [y/n]
# confirmations, etc.) must go above this block; everything else may go below.
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
fi

export PATH="/usr/local/bin:$PATH"
export ZSH="$HOME/.oh-my-zsh"
ZSH_THEME="powerlevel10k/powerlevel10k"

plugins=(
zsh-autosuggestions
zsh-syntax-highlighting
)

source $ZSH/oh-my-zsh.sh
source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
source ~/.zsh/zsh-syntax-highlighting/zsh-syntax-highlighting.zsh

# To customize prompt, run `p10k configure` or edit ~/.p10k.zsh.
[[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh

# Aliases
alias ls='colorls'
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion

export PATH="/opt/homebrew/Cellar/node/22.9.0_1/bin:$PATH"

20 changes: 20 additions & 0 deletions docusaurus/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions docusaurus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions docusaurus/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
156 changes: 156 additions & 0 deletions docusaurus/docs/api-docs/1.0.0/access-all-student-orgs-at-osu.api.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
---
id: access-all-student-orgs-at-osu
title: "Access all student orgs at OSU"
description: "Access all student orgs at OSU"
sidebar_label: "GET student orgs"
hide_title: true
hide_table_of_contents: true
api: eJy9VU1vGzkM/SuCTg1ge9LFnnyq4U2T7CZN0HG2hyQHeoaeYaKRtPoYr9fwf19KM03jNujeFjBgmSIfKfLxeS8DNF7O76UPsUYdpsbx78eJdOit0R75ci9/OT1NXzX6ypENZLScy0VVofeijPlbTmRldGCI5AnWKqogeRZPPrnvpa9a7CCdws4iA5j1E1aBA60zFl2gIZmGDl95+eBIN+zVkb5C3YRWzt8fOCg6azyWAQJ2Y9qfhUykjkrBWrFHcBEZooLOxvGJYyg4B7sh8pJx/RuBExk1/RVxvB9MNPz4sQTUsUv9XRoVu3VMfboibsNEXoNLjUwHvyFUNR8/4RbcMx++GOMDujSJQCGllstcrTzkwgM2xtH/U/qigho7qgp+g8IG+WrBZaLmsReLKlBPvmPj0nQd44edKNH1VGExfosrBKcH0KVDpkWPAnQtbtFtjOOCG7FwIfXmLLQ6ZYoqRAeKLeemR6dBM8yNa0DTP5lWyfnCaOMgtaHIR1GaijDziLuKNcFE/G4iRyuucJJTvuT/4igMJX1GRQ2Z6IvSEltjzpuwQImPjnvNxSfUojTOOBoTlBazxyWznrclZJPhZ+Q8n7HKmfKEV1i12ijTpPmcO6gjg/Lx1pkNN5Gdcso7XaNrvl6/Gn05LCe/fzlMfsc0OLx1n+zp5s1VBaXEuOci7bmAIG7Ku8QZDK2p2bPBvJCQVkYWR6IwkZ7HiS7JxV5Gp9ijDcH6eVGApZnxcVZjX/Tv5YFrJ70xmVVjjb+d/SmmYnF7Kb+v7sainnqeE4+Y7wXq2hrS3EgWhp7qRI93UZvNhlLDT4SNa1YXtZtCD5TpLWoIIGBtYhCrlpnSkhFZGsSdplQ003L2oB/0qiUv+ANi61il0AlmoPjwjImFLRb8ChEM1zDAYi9gaF5ySw1UoJsIDfrZQGvRGYfz+YOeivtjGKPFp9vrx3dfm7Tdbmfadk9+VpmusFA9M0xxFHPyBsw5hYu4ZkKx3FHg2X9DbCi0cZ3h/sghF1jwQE9GMYYqqyKrLqVh8WM+pCFhHSVThFuILPDfJFdeX6448niyVctKhDA651Tj2RcdhSIh5f7mUZ7Ofp2dJhPXGjrQr8D/k4NHpHhRo4B/h8IqIJ1gc237kZ8//mm1nDXZ9/s1eLxz6nBIZlY83pj5PR97lotBD+8fGa9FljaXCf2Mu7FKm1agBxWzqn7/T5a4/bIu52cr3rh/AYVUhtc=
sidebar_class_name: "get api-method"
info_path: ./docs/api-docs/1.0.0/dev-api
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
as={"h1"}
className={"openapi__heading"}
children={"Access all student orgs at OSU"}
>
</Heading>

<MethodEndpoint
method={"get"}
path={"/student-orgs"}
context={"endpoint"}
>

</MethodEndpoint>



Access all student orgs at OSU

<div>
<div>
<ApiTabs
label={undefined}
id={undefined}
>
<TabItem
label={"200"}
value={"200"}
>
<div>


Access Success


</div><div>
<MimeTabs
className={"openapi-tabs__mime"}
schemaType={"response"}
>
<TabItem
label={"application/json"}
value={"application/json"}
>
<SchemaTabs
className={"openapi-tabs__schema"}
>
<TabItem
label={"Schema"}
value={"Schema"}
>
<details
style={{}}
className={"openapi-markdown__details response"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-response"}
>
<strong>
Schema
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>

</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"purposeStatement"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1,"nullable":true}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"campuses"}
required={false}
schemaName={"Campus (string)[]"}
qualifierMessage={"**Possible values:** [`Columbus`, `Lima`, `Marion`, `Masfield`, `Newark`, `Wooster`], `>= 1`"}
schema={{"type":"array","minItems":1,"nullable":true,"uniqueItems":true,"items":{"type":"string","enum":["Columbus","Lima","Marion","Masfield","Newark","Wooster"],"title":"Campus"}}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"categories"}
required={false}
schemaName={"StudentOrgCategory (string)[]"}
qualifierMessage={"**Possible values:** [`Academic/College`, `Awareness/Activism`, `Community Service/Service Learning`, `Creative and Performing Arts`, `Ethnic/Cultural`, `Governance Organizations`, `Honoraries/Honor Societies`, `Media, Journalism, and Creative Writing`, `Religious/Spiritual`, `Social Fraternities/Sororities`, `Special Interest`, `Sports and Recreation`, `Technology`, `Graduate`, `Professional`, `Undergraduate`], `>= 1`"}
schema={{"type":"array","minItems":1,"nullable":true,"uniqueItems":true,"items":{"type":"string","enum":["Academic/College","Awareness/Activism","Community Service/Service Learning","Creative and Performing Arts","Ethnic/Cultural","Governance Organizations","Honoraries/Honor Societies","Media, Journalism, and Creative Writing","Religious/Spiritual","Social Fraternities/Sororities","Special Interest","Sports and Recreation","Technology","Graduate","Professional","Undergraduate"],"title":"StudentOrgCategory"}}}
>

</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"name\": \"string\",\n \"purposeStatement\": \"string\",\n \"campuses\": [\n \"Columbus\"\n ],\n \"categories\": [\n \"Academic/College\"\n ]\n}"}
language={"json"}
>

</ResponseSamples>
</TabItem>
</SchemaTabs>
</TabItem>
</MimeTabs>
</div>
</TabItem>
</ApiTabs>
</div>
</div>

Loading