Skip to content

Commit

Permalink
Cleaning up new lines (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
userbradley authored Dec 30, 2023
1 parent 8141d21 commit ad7224d
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 42 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.idea
.DS_Store
.cache
site/
site/
4 changes: 0 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ repos:
name: Ensure files have end of file
- id: trailing-whitespace
name: Trims extra whitespaces
- id: check-toml
name: Checks TOML files
- repo: https://github.com/google/yamlfmt
rev: v0.10.0
hooks:
Expand All @@ -19,8 +17,6 @@ repos:
- repo: https://github.com/python-jsonschema/check-jsonschema
rev: 0.26.3
hooks:
- id: check-github-actions
name: GitHub actions check
- id: check-dependabot
name: GitHub Workflows
- id: check-dependabot
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Any reference to something like `/feeds/` assumes you just go `https://mobile.be

## Endpoints

The below contains an overview of the endpoints.
The below contains an overview of the endpoints.

### Metric Collection

Expand All @@ -75,13 +75,13 @@ The below contains an overview of the endpoints.
### BeReal Application Specific requests


#### Storage
#### Storage
| URL | Use | Request type |
|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|----------------|
| `https://storage.bere.al/Photos/<uid>` | Where the user generated images are stored, backed by a [GCS Bucket](https://cloud.google.com/storage) | `GET HTTP/2.0` |
| `https://bereal-us-central1-memories.storage.googleapis.com` | Memories 2022 recap video storage | `GET HTTP/2.0` |


#### Feeds


Expand Down Expand Up @@ -160,9 +160,9 @@ The below contains an overview of the endpoints.
|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|----------------|
| `https://berealapp.zendesk.com/api/private/mobile_sdk/settings/id.json` | Where the user send message to the help service [Bereal use Zendesk](https://www.zendesk.fr) | `GET HTTP/2.0` |
| `https://berealapp.zendesk.com/attachments/token/ID/?name=ID.jpeg` | Where the user Photo is stored (help message) | `GET HTTP/2.0` |



## Domains

Below contains the _top level_ domains that BeReal uses
Expand Down Expand Up @@ -306,7 +306,7 @@ Response (Un-authenticated)
### feeds/friends-v1
When the app opens, it makes a call to `api/feed/friends-v1`

Below is an example, with PII removed.
Below is an example, with PII removed.
```json
{
"userPosts": {
Expand Down Expand Up @@ -692,7 +692,7 @@ What it sends:
}
```

Response
Response

```json
{
Expand All @@ -702,7 +702,7 @@ Response

### Firebase push

Request
Request

```json
{
Expand Down Expand Up @@ -743,7 +743,7 @@ Request

This is the API endpoint bereal posts to when it's finalizing the post

Request
Request

```json
{
Expand Down
2 changes: 1 addition & 1 deletion docs/api-endpoints/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ title: "API endpoint: Analytics"
"version": "1.1.2",
"version.build": "9854"
},
```
```
2 changes: 0 additions & 2 deletions docs/api-endpoints/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,5 +117,3 @@ Response
]
}
```


2 changes: 1 addition & 1 deletion docs/api-endpoints/feeds.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,4 +555,4 @@ title: "API endpoint: Analytics"
"createdAt": "2006-01-02T15:04:05-0700"
}
}
```
```
6 changes: 3 additions & 3 deletions docs/api-endpoints/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ title: "API endpoint: messaging"
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetMessages` | GET message |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetConversationsById` | GET message with the member id |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetConversationFeed` | GET the conversation Feed |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetPendingInvites` | GET the pending invitations |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/ClearConversation` | POST clear message Feed |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetSentInvites` | GET invitations |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetPendingInvites` | GET the pending invitations |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/ClearConversation` | POST clear message Feed |
| `https://ogma.bereal.team/chat.core.v1.ChatCoreService/GetSentInvites` | GET invitations |
1 change: 0 additions & 1 deletion docs/api-endpoints/moderation.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,3 @@ title: "API endpoint: Moderation"
]
}
```

3 changes: 1 addition & 2 deletions docs/eula.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,10 @@ This End User License Agreement ("Agreement") is a legal agreement between you (
This Agreement constitutes the entire agreement between you and the Site regarding your use of the Site, superseding any prior agreements or understandings.


<br>
<br>
By accessing the Site, you acknowledge that you have read, understood, and agree to be bound by this End User License Agreement. If you do not agree to these terms, you should not access or use the Site.


Last updated: 15-jul-2023 16:05:33 UTC

BeReal API Documentation

2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ This site is laid out so that each section in the Navigation on the left, is a s

If you want to get Involved in this site, open a Pull request adding or fixing what ever the issue was.

## Stargazers
## Stargazers

[![Stargazers over time](https://starchart.cc/userbradley/BeReal.svg)](https://starchart.cc/userbradley/BeReal)
15 changes: 2 additions & 13 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,19 @@ nav:
- Search: api-endpoints/search.md
- Core: api-endpoints/core.md
- Spotify: api-endpoints/spotify.md


## Config ##


repo_name: BeReal API Documentation
repo_url: https://github.com/userbradley/BeReal
edit_uri: edit/dev/docs/
site_name: "BeReal API Documentation"
site_description: BeReal API Documentation
site_url: "https://userbradley.github.io/BeReal"

#extra_css:
# - stylesheets/custom.css # Custom header color

theme:
name: material
# favicon: favicon.ico
# logo: favicon.png
# favicon: favicon.ico
# logo: favicon.png
icon:
repo: fontawesome/brands/github-alt
admonition:
Expand All @@ -52,7 +46,6 @@ theme:
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16

palette:
- scheme: default
toggle:
Expand All @@ -73,9 +66,6 @@ theme:
- content.tabs.link
- search.share
# - search.highlight



markdown_extensions:
- admonition
- pymdownx.details
Expand Down Expand Up @@ -105,7 +95,6 @@ markdown_extensions:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
- search
- social
Expand Down
2 changes: 1 addition & 1 deletion public.json
Original file line number Diff line number Diff line change
Expand Up @@ -859,4 +859,4 @@
}
],
"lastIndex": "1660004279768-0"
}
}

0 comments on commit ad7224d

Please sign in to comment.